From 699786475fa37c3f101eb2950130cc9aa6e67f73 Mon Sep 17 00:00:00 2001
From: Bastian Dehn <hhaalo@arcor.de>
Date: Sat, 30 Mar 2024 09:11:03 +0100
Subject: [PATCH] add readme

---
 readme.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5fe8b53
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,57 @@
+# Sane backend for Kodak s2000w series (network)
+
+It is a sane backend ([SANE - Scanner Access Now Easy](http://sane-project.org))
+for the [scanner s2000w series](https://support.alarisworld.com/de-de/s2080w-scanner)  
+It communicate with the scanner over the network. (RESTful API)
+
+## Dependencies
+
+### Build dependencies
+
+- [sane](https://sane-project.gitlab.io/standard/api.html) - sane project
+- [confuse](https://www.nongnu.org/confuse/manual/index.html) - read config file
+- [curl](https://curl.se/libcurl) - communicate with scanner
+- [json-c](https://json-c.github.io/json-c/json-c-current-release/doc/html/index.html) - parse response
+- [imagemagick](https://imagemagick.org/script/magick-core.php) - convert jpg to pnm
+- math - calc bytes per line
+
+### Test dependencies
+
+- [cmocka](https://api.cmocka.org/) - test framwork
+
+## Build
+
+```bash
+mkdir build && cd build
+cmake ..
+make
+sudo make install
+```
+
+### DEB-Package
+
+```bash
+mkdir build && cd build
+cmake ..
+make package
+```
+
+### Configuration
+
+add `kds_s2000_net` to the file `/etc/sane.d/dll.conf`.
+
+change config file properties from this file `/etc/sand.d/kds_s2000w_net.conf`
+
+```bash
+scanner_url = "https://scanner.example.com"
+username = "muster"
+```
+
+## Develop with Tests
+
+build with tests and run it
+
+```bash
+cmake -DRUN_TESTS=on ..
+make
+```
\ No newline at end of file
-- 
2.39.5