summaryrefslogtreecommitdiff
path: root/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 /README.md
parent269974bfb404016bd592358df7b43f8ece82ddc9 (diff)
parent7ac7082eb0fa3735eb23acf72dbe607217a358c2 (diff)
Merge branch 'feature/upstrem' into develop
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 44 insertions, 7 deletions
diff --git a/README.md b/README.md
index a6ee6dc..eade28d 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,14 @@ It allows you to capture images using [image scanners](https://en.wikipedia.org/
# Building from source
-Install the dependencies (first line is Ubuntu/Debian, second is Fedora):
+Install the dependencies
+
+For Ubuntu/Debian:
```
$ sudo apt install git meson valac libgtk-3-dev libgusb-dev libcolord-dev libpackagekit-glib2-dev libwebp-dev libsane-dev gettext itstool
```
+
+For Fedora:
```
$ sudo dnf install -y meson vala gettext itstool gtk3-devel libgusb-devel colord-devel PackageKit-glib-devel libwebp-devel sane-backends-devel
```
@@ -25,28 +29,28 @@ $ cd simple-scan
Build and run:
```
-$ meson --prefix $PWD/install build/
-$ ninja -C build/ all install
-$ XDG_DATA_DIRS=install/share:$XDG_DATA_DIRS ./install/bin/simple-scan
+$ meson --prefix $PWD/_install _build
+$ ninja -C _build all install
+$ XDG_DATA_DIRS=_install/share:$XDG_DATA_DIRS ./_install/bin/simple-scan
```
# Debugging
-There is a --debug command line switch to enable more verbose logging:
+There is a `--debug` command line switch to enable more verbose logging:
```
$ simple-scan --debug
```
Log messages can also be found in the `$HOME/.cache/simple-scan` folder.
-If you don't have a scanner ready, you can use a virtual "test" scanner:
+If you don't have a scanner ready, you can use a virtual `test` scanner:
```
$ simple-scan --debug test
```
This app works by using the [SANE API](http://sane-project.org/html/) to
capture images. It chooses the settings it thinks are appropriate for what you
-are trying to do. Drivers have many options and are of differring quality - it
+are trying to do. Drivers have many options and are of differing quality - it
is useful to work out if any issues are caused by the app or the drivers. To
confirm it is a driver issue you can use the graphical tool (XSane) or the
command line
@@ -54,8 +58,41 @@ command line
by the SANE project - these allow to to easily see and control all the
settings your driver provides.
+If XSane is also not working, then the issue could be casued by wrongly
+loaded backend. To enable debug traces on Sane, set `SANE_DEBUG_DLL`
+environment variable:
+
+```
+$ export SANE_DEBUG_DLL=255
+```
+
+When set, SANE backends will show informational messages while
+*Document Scanner* is running
+
+Example:
+
+With HP MFP 135a scanner, there is missing `libusb-0.1.so.4`
+shared library, during loading `smfp` prioprietary backend:
+
+```
+[dll] sane_get_devices
+[dll] load: searching backend `smfp' in `/usr/lib/x86_64-linux-gnu/sane:/usr/lib/sane'
+[dll] load: trying to load `/usr/lib/x86_64-linux-gnu/sane/libsane-smfp.so.1'
+[dll] load: couldn't open `/usr/lib/x86_64-linux-gnu/sane/libsane-smfp.so.1' (No such file or directory)
+[dll] load: trying to load `/usr/lib/sane/libsane-smfp.so.1'
+[dll] load: dlopen()ing `/usr/lib/sane/libsane-smfp.so.1'
+[dll] load: dlopen() failed (libusb-0.1.so.4: No such file or directory)
+```
+
# Contributing
To contribute code create merge requests on
[gitlab.gnome.org](https://gitlab.gnome.org/GNOME/simple-scan). If you
find issues please [report them](https://gitlab.gnome.org/GNOME/simple-scan/issues).
+
+## Translation
+
+A lot of information about translation process can be found at
+[GNOME TranslationProject](https://wiki.gnome.org/TranslationProject/).
+The translation files for *Document Scanner* User Interface and User Guide,
+are available [here](https://l10n.gnome.org/module/simple-scan/).