summaryrefslogtreecommitdiff
path: root/data/logs/README.md
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff.email>2020-03-22 17:06:19 +0100
committerJörg Frings-Fürst <debian@jff.email>2020-03-22 17:06:19 +0100
commit36ea9e0aa630a76096d25fedbf6abf5c0463cfda (patch)
treeeaaa24afe631aaee5c974eae548f6a0d52ad9677 /data/logs/README.md
parent269974bfb404016bd592358df7b43f8ece82ddc9 (diff)
parent7ac7082eb0fa3735eb23acf72dbe607217a358c2 (diff)
Merge branch 'feature/upstrem' into develop
Diffstat (limited to 'data/logs/README.md')
-rw-r--r--data/logs/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/data/logs/README.md b/data/logs/README.md
new file mode 100644
index 0000000..4e5e370
--- /dev/null
+++ b/data/logs/README.md
@@ -0,0 +1,36 @@
+
+# Introduction
+
+The purpose of logs, is to gather information about options of different scanners.
+
+# How to use it
+
+If you would like to check minimum and maximum values of the `brightness`, you could type:
+```
+ $ cd data/descriptors
+ $ git grep name=\'brightness\'
+```
+The output of this command will be for example:
+```
+Canon_LiDE_220.log:[+5,91s] DEBUG: scanner.vala:735: Option 24: name='brightness' title='Brightness' type=int size=4 min=-100, max=100, quant=1 cap=soft-select,soft-detect
+Epson_NX300.log:[+58,31s] DEBUG: Option 6: name='brightness' title='Brightness' type=int size=4 min=0, max=0, quant=0 cap=soft-select,soft-detect,inactive
+Hewlett-Packard_Officejet_4630_series.log:[+10,75s] DEBUG: scanner.vala:742: Option 6: name='brightness' title='Brightness' type=int size=4 min=0, max=2000, quant=0 cap=soft-select,soft-detect,advanced
+````
+
+The first word is the file name (eg. `Canon_LiDE_220.log`), which corresponding to Scanner/Printer model.
+You could notice that for `Canon_LiDE_220` the `brightness` range is `-100,100`,
+for `Epson_NX300` it is `0,0`, as the descriptor is inactive and for `HP_4630` the range is `0,2000`.
+
+# How to add new logs
+
+1. Run simple scan in debug mode:
+
+ $ simple-scan --debug
+
+1. Press scan button
+
+1. Create new `.log` file
+
+1. Copy logs from terminal to a new file
+
+1. Create Merge Request