Documentation and README.md update

This commit is contained in:
Roberto Rosario
2011-08-19 14:18:03 -04:00
parent e55863aaa1
commit 4f029cbc01
7 changed files with 12 additions and 51 deletions

View File

@@ -7,46 +7,8 @@ Open source, Django based document manager with custom metadata indexing, file s
[Video demostration](http://bit.ly/pADNXv)
Basic requirements
---
[Documentation](http://readthedocs.org/docs/mayan/en/latest/)
Python:
* Django - A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
* django-pagination
* django-filetransfers - File upload/download abstraction
* celery- asynchronous task queue/job queue based on distributed message passing
* django-celery - celery Django integration
* django-mptt - Utilities for implementing a modified pre-order traversal tree in django
* python-magic - A python wrapper for libmagic
* django-taggit - Simple tagging for django
* slate - The simplest way to extract text from PDFs in Python
Execute pip install -r requirements/production.txt to install the python/django dependencies automatically.
Executables:
* tesseract-ocr - An OCR Engine that was developed at HP Labs between 1985 and 1995... and now at Google.
* unpaper - post-processing scanned and photocopied book pages
Optional requirements
---
For the GridFS storage backend:
* PyMongo - the recommended way to work with MongoDB from Python
* GridFS - a storage specification for large objects in MongoDB
* MongoDB - a scalable, open source, document-oriented database
Libraries:
* libmagic - MIME detection library, if not installed Mayan will fall back to using python's simpler mimetype built in library
Mayan has the ability to switch between different image conversion backends, at the moment these two are supported:
* ImageMagick - Convert, Edit, Or Compose Bitmap Images
* GraphicMagick - Robust collection of tools and libraries to read, write, and manipulate an image.
License
-------
@@ -61,13 +23,3 @@ Roberto Rosario - [Twitter](http://twitter.com/#siloraptor) [E-mail](mailto://ro
Donations
---------
Please [donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W6LMMZHTNUJ6L) if you are willing to support the further development of this project.
Credits
-------
See docs/CREDITS file.
FAQ
---
See docs/FAQ file for common questions and issues.

BIN
docs/_static/mayan_architecture.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
docs/_static/pyramid.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

@@ -110,7 +110,7 @@ html_theme = 'default'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = '_static/pyramid.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

View File

@@ -1,6 +1,7 @@
===
FAQ
===
Frequently asked questions and solutions

View File

@@ -9,7 +9,7 @@ Open source, Django_ based document manager with custom metadata indexing, file
:Website: http://bit.ly/mayan-edms
:Source: http://github.com/rosarior/mayan
:Video: http://bit.ly/pADNXv
Overview
========
@@ -29,6 +29,7 @@ Contents
features
requirements
installation
technical
updates
contributors
credits

7
docs/technical.rst Normal file
View File

@@ -0,0 +1,7 @@
=========
Internals
=========
|architecture|
.. |architecture| image:: _static/mayan_architecture.png