Skip to content

Commit

Permalink
Update information about how it works
Browse files Browse the repository at this point in the history
  • Loading branch information
CoolCat467 committed Apr 17, 2023
1 parent eae3dd1 commit 5ef040a
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Scanner-Server
[![Tests](https://github.com/CoolCat467/Scanner-Server/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/CoolCat467/Scanner-Server/actions/workflows/tests.yml)

Kind of like CUPS but it's for scanning, not printing.

[![Tests](https://github.com/CoolCat467/Scanner-Server/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/CoolCat467/Scanner-Server/actions/workflows/tests.yml)

![thumbnail](./img/thumbnail.png)

This is basically a web interface for the `scanimage` Linux command-line tool which talks
to devices through the SANE (Scanner Access Now Easy) interface.
This is basically a web interface for scanner devices through the SANE (Scanner Access Now Easy) interface.

This program is intended to be used alongside CUPS, but may not be required.
This program is intended to be used alongside CUPS, but this should not be required.

The web server is hosted on port `3004` on default when running.
This can be changed in `config.ini`
On default, the web server is hosted on port `3004`.
This can be changed in `~/.sanescansrv/config.ini`

You will need `libsane-dev` to be able to install `python-sane`.
Use APT or your system's equivalent to install.

## Installation
```console
sudo apt install libsane-dev
sudo apt-get install libsane-dev
git clone https://github.com/CoolCat467/Scanner-Server.git
pip install Scanner-Server/
```
Expand Down

0 comments on commit 5ef040a

Please sign in to comment.