paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Added a screenshot and cleaned things up a bit.

Browse Source
This commit is contained in:
Daniel Quinn 2016-02-16 09:22:51 +00:00
parent 5de4951a46
commit bbe7a02b4d
1 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.rst
View File

@ -1,10 +1,8 @@
Paperless Paperless
######### #########
.. image:: https://badges.gitter.im/danielquinn/paperless.svg
:alt: Join the chat at https://gitter.im/danielquinn/paperless
:target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|Documentation| |Documentation|
|Chat|
Scan, index, and archive all of your paper documents Scan, index, and archive all of your paper documents
@ -33,7 +31,12 @@ How it Works
like with it. You can even print it and send it as if it's the original. like with it. You can even print it and send it as if it's the original.
In most cases, no one will care or notice. In most cases, no one will care or notice.
.. _this one: http://www.brother.ca/en-CA/Scanners/11/ProductDetail/ADS1500W?ProductDetail=productdetail Here's what you get:
.. image:: docs/_static/screenshot.png
:alt: The before and after
:target: docs/_static/screenshot.png
Stability Stability
========= =========
@ -67,23 +70,12 @@ Imagemagick > Pillow > PyOCR > Tesseract > text. It's not ideal, but
apparently, Pillow lacks the ability to read PDFs, and PyOCR requires a Pillow apparently, Pillow lacks the ability to read PDFs, and PyOCR requires a Pillow
object, so we're sort of stuck. object, so we're sort of stuck.
.. _ImageMagick: http://imagemagick.org/
.. _Tesseract: https://github.com/tesseract-ocr
.. _GNU Privacy Guard: https://gnupg.org/
.. _Python 3: https://python.org/
.. _Pillow: https://pypi.python.org/pypi/pillowfight/
.. _PyOCR: https://github.com/jflesch/pyocr
.. _Django: https://djangoproject.org/
.. _Python-GNUPG: http://pythonhosted.org/python-gnupg/
Documentation Documentation
============= =============
It's all available on `ReadTheDocs`_. It's all available on `ReadTheDocs`_.
.. _ReadTheDocs: https://paperless.readthedocs.org/
Important Note Important Note
============== ==============
@ -97,6 +89,20 @@ means that paperless should never be run on an untrusted host. Instead, I
recommend that if you do want to use it, run it locally on a server in your own recommend that if you do want to use it, run it locally on a server in your own
home. home.
.. _this one: http://www.brother.ca/en-CA/Scanners/11/ProductDetail/ADS1500W?ProductDetail=productdetail
.. _ImageMagick: http://imagemagick.org/
.. _Tesseract: https://github.com/tesseract-ocr
.. _GNU Privacy Guard: https://gnupg.org/
.. _Python 3: https://python.org/
.. _Pillow: https://pypi.python.org/pypi/pillowfight/
.. _PyOCR: https://github.com/jflesch/pyocr
.. _Django: https://djangoproject.org/
.. _Python-GNUPG: http://pythonhosted.org/python-gnupg/
.. _ReadTheDocs: https://paperless.readthedocs.org/
.. |Documentation| image:: https://readthedocs.org/projects/paperless/badge/?version=latest .. |Documentation| image:: https://readthedocs.org/projects/paperless/badge/?version=latest
:alt: Read the documentation at https://paperless.readthedocs.org/ :alt: Read the documentation at https://paperless.readthedocs.org/
:target: https://paperless.readthedocs.org/ :target: https://paperless.readthedocs.org/
.. |Chat| image:: https://badges.gitter.im/danielquinn/paperless.svg
:alt: Join the chat at https://gitter.im/danielquinn/paperless
:target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge