matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Convert README file to restructured text, add contributors section

Browse Source
This commit is contained in:
Roberto Rosario
2014-05-20 03:13:50 -04:00
parent 96d55dd3f9
commit 63d9f02fdd
3 changed files with 88 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@@ -1,59 +0,0 @@
[![Build Status](https://travis-ci.org/mayan-edms/mayan-edms.svg?branch=master)](https://travis-ci.org/mayan-edms/mayan-edms)
[![Coverage Status](https://coveralls.io/repos/mayan-edms/mayan-edms/badge.png?branch=master)](https://coveralls.io/r/mayan-edms/mayan-edms?branch=master)
![Logo](https://github.com/rosarior/mayan/raw/master/docs/_static/mayan_logo_landscape_black.jpg)
Mayan EDMS
==========
Open source, Django based document management system with custom metadata
indexing, file serving integration, tagging, digital signature verification,
text parsing and OCR capabilities.
[Website](http://www.mayan-edms.com)
[Video demostration](http://bit.ly/pADNXv)
[Documentation](http://readthedocs.org/docs/mayan/en/latest/)
[Translations](https://www.transifex.net/projects/p/mayan-edms/)
[Mailing list (via Google Groups)](http://groups.google.com/group/mayan-edms)
Quick install
-------------
To bootstrap **Mayan EDMS** via the fabfile without having to clone the
entire repository, run the following command, replacing the part that
reads: <Your MySQL root password> with your current MySQL root password
or the MySQL root password you plan to assign to it, during the MySQL
installation when executing the fabfile.
- Debian or Ubuntu:
cd /tmp && sudo apt-get install -y fabric wget tar gzip && wget https://github.com/rosarior/mayan/raw/master/contrib/fabfile.tar.gz -O - | tar -xvzf - && echo "database_manager_admin_password=&lt;Your MySQL root password&gt;" > ~/.fabricrc && fab -H localhost install
- Fedora:
cd /tmp && sudo yum install -y fabric wget tar gzip && wget https://github.com/rosarior/mayan/raw/master/contrib/fabfile.tar.gz -O - | tar -xvzf - && echo "database_manager_admin_password=&lt;Your MySQL root password&gt;" > ~/.fabricrc && fab -H localhost install
License
-------
This project is open sourced under [GNU GPL Version 3](http://www.gnu.org/licenses/gpl-3.0.html).
Author
------
Roberto Rosario - [Twitter](http://twitter.com/#siloraptor) [E-mail](mailto://roberto.rosario@mayan-edms.com)
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.
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rosarior/mayan/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

85
README.rst Normal file
View File

@@ -0,0 +1,85 @@
|Build Status|
|Coverage Status|
|Logo|
Mayan EDMS
==========
Free Open Source, Django based document management system with custom metadata
indexing, file serving integration, tagging, digital signature verification,
text parsing and OCR capabilities.
`Website`_
`Video demostration`_
`Documentation`_
`Translations`_
`Mailing list (via Google Groups)`_
Quick install
-------------
To bootstrap **Mayan EDMS** via the fabfile without having to clone
the entire repository, run the following command, replacing the part that
reads: with your current MySQL root password or the MySQL root password
you plan to assign to it, during the MySQL installation when executing the fabfile.
- Debian or Ubuntu:
cd /tmp && sudo apt-get install -y fabric wget tar gzip && wget
https://github.com/rosarior/mayan/raw/master/contrib/fabfile.tar.gz
-O - \| tar -xvzf - && echo “database\_manager\_admin\_password=<Your
MySQL root password>” > ~/.fabricrc && fab -H localhost install
- Fedora:
cd /tmp && sudo yum install -y fabric wget tar gzip && wget
https://github.com/rosarior/mayan/raw/master/contrib/fabfile.tar.gz
-O - \| tar -xvzf - && echo “database\_manager\_admin\_password=<Your
MySQL root password>” > ~/.fabricrc && fab -H localhost install
License
-------
This project is open sourced under `GNU GPL Version 3`_.
Contribute
----------
- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
- Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it).
- Write a test which shows that the bug was fixed or that the feature works as expected.
- Send a pull request
- Make sure to add yourself to the `contributors file`_.
Donations
---------
Please `donate`_ if you are willing to support the further development
of this project.
.. _Website: http://www.mayan-edms.com
.. _Video demostration: http://bit.ly/pADNXv
.. _Documentation: http://readthedocs.org/docs/mayan/en/latest/
.. _Translations: https://www.transifex.net/projects/p/mayan-edms/
.. _Mailing list (via Google Groups): http://groups.google.com/group/mayan-edms
.. _GNU GPL Version 3: http://www.gnu.org/licenses/gpl-3.0.html
.. _Twitter: http://twitter.com/#siloraptor
.. _E-mail: mailto://roberto.rosario@mayan-edms.com
.. _donate: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W6LMMZHTNUJ6L
.. |Build Status| image:: https://travis-ci.org/mayan-edms/mayan-edms.svg?branch=master
:target: https://travis-ci.org/mayan-edms/mayan-edms
.. |Coverage Status| image:: https://coveralls.io/repos/mayan-edms/mayan-edms/badge.png?branch=master
:target: https://coveralls.io/r/mayan-edms/mayan-edms?branch=master
.. |Logo| image:: https://github.com/rosarior/mayan/raw/master/docs/_static/mayan_logo_landscape_black.jpg
.. _`the repository`: http://github.com/mayan-edms/mayan-edms
.. _`contributors file`: https://github.com/mayan-edms/mayan-edms/blob/master/docs/credits/contributors.rst

3
docs/credits/contributors.rst
View File

@@ -10,6 +10,9 @@ How to contribute?
You can help further the development of **Mayan EDMS** by reporting bugs, submitting documentation, patches, with monetary or hardware donations.
Lead developer
--------------
* Roberto Rosario (roberto.rosario.gonzalez@gmail.com) <https://twitter.com/siloraptor>
Bug fixes
---------