aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2017-03-02 06:56:05 -0700
committerSean Whitton <spwhitton@spwhitton.name>2017-03-02 06:56:05 -0700
commitaa5bdcf9a7ca4a162b55f2d3b0312a5d40434a7a (patch)
tree704b18e6ba051a9959d01de9cdeeb0b8f970f966
parentb287f9b2a5807625cf4d5d82ad908104fa4c6653 (diff)
downloadsscan-aa5bdcf9a7ca4a162b55f2d3b0312a5d40434a7a.tar.gz
tidy up docs & add a screenshot
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md13
-rw-r--r--README.md45
-rw-r--r--screenshot.pngbin0 -> 38362 bytes
3 files changed, 40 insertions, 18 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..32cf2b6
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+Thank you for your interest in contributing to this project!
+
+Please **do not** submit a pull request on GitHub. This repository is
+an automated mirror, and I don't develop using GitHub's platform.
+
+Instead, either
+
+- publish a branch somewhere (a GitHub fork is fine), and e-mail
+ <spwhitton@spwhitton.name> asking me to merge your branch, possibly
+ using git-request-pull(1)
+
+- prepare patches with git-format-patch(1), and send them to
+ <spwhitton@spwhitton.name>, possibly using git-send-email(1)
diff --git a/README.md b/README.md
index f36b680..72c062a 100644
--- a/README.md
+++ b/README.md
@@ -8,39 +8,49 @@ command and a flatbed scanner.
I wrote sscan because I often need to scan multi-page documents on my
GNU/Linux system, and I have only a flatbed scanner, without an ADF.
-sscan was originally a crude Python script. Now it is a Haskell
-program.
+sscan was originally a crude Python script. Now it is a somewhat more
+robust Haskell program, relying on the [Brick][] library.
+
+[Brick]: https://github.com/jtdaugherty/brick/
## Screenshot
-[later]
+![screenshot](screenshot.png)
## Installation
1. Ensure that your scanner has [SANE support][].
-2. Install prerequisite utilities: `apt-get install ocrmypdf pdftk
- sane-utils haskell-stack`.
-3. Obtain sscan source: `git clone https://git.spwhitton.name/sscan`
-4. Optionally, modify the file `Presets.hs` so that it contains
- settings presets for the scanning tasks you most often need to
- perform.
-5. Use [stack][] to build and install sscan: `cd sscan && stack
- install`.
-
-Note that stack will download various dependencies automatically. I
-hope that future versions of sscan will require only dependencies
-available from the Debian mirrors.
+2. Install prerequisite utilities:
+````
+apt-get install ocrmypdf pdftk sane-utils haskell-stack imagemagick
+````
+3. Use [stack][] to build and install sscan:
+````
+stack --resolver=lts-8.2 install sscan`
+````
+
+Note that stack will automatically download and install the various
+Haskell dependencies of sscan -- unfortunately, these are not yet
+likely to all be installable from your distribution's mirrors.
[SANE support]: http://www.sane-project.org/sane-supported-devices.html
[stack]: https://haskellstack.org/
+## Configuration
+
+sscan does not yet have a configuration file. If it did, this could
+be used to configure the available presets, the default settings on
+startup, and the output directory. Patches welcome.
+
## Usage
Open a terminal, run `sscan` and follow the on-screen instructions.
+If you can't see all the key bindings, you will need to increase the
+size of your terminal.
-## Bugs
+## Bugs/patches
-Please report bugs by e-mail to `<spwhitton@spwhitton.name>`.
+By e-mail to `<spwhitton@spwhitton.name>`.
## License
@@ -59,4 +69,3 @@ for more details.
You should have received a copy of the GNU General Public License
along with sscan. If not, see
[<http://www.gnu.org/licenses/>](http://www.gnu.org/licenses/).
-
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..f2d8890
--- /dev/null
+++ b/screenshot.png
Binary files differ