Skip to content

Commit

Permalink
Finished documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Thibaut DIRLIK committed Jun 22, 2011
1 parent a4df9e1 commit 1b30a53
Show file tree
Hide file tree
Showing 5 changed files with 193 additions and 132 deletions.
27 changes: 1 addition & 26 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1 @@
OpenERP Rent
============

This module has been written from scratch by WE2BS (http://www.we2bs.com) and let you rent products to your customers.
It is fully integrated with stock management, uses Aeroo Reports engine, and is easily extendable. This module has
been partially financed by the Rtz Évènement company (http://www.rtzevenement.fr).

How to contribute
-----------------

We need feedbacks about the module :

* Bug reports
* Features requests
* Opinions

Please, open github issues and report such things !

If you want to contribute to code, fork the project and send us a pull request with your improvements !

Documentation
-------------

You can read (or contribute to) the documentation on the wiki : https://github.com/WE2BS/openerp-rent/wiki !
You can also translate the documentation if you want. Feel free to edit the wiki.

Read the documentation on http://doc.we2bs.com/openerp-rent/ !
27 changes: 23 additions & 4 deletions docs/source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,27 @@ This module is an open-source project and we need contributors to make it better
Translate OpenERP Rent
----------------------

Currently, the module is only available in ``French``, ``English``. If you want to translate it, follow these
instructions (the module must be installed) :
Because it's not easy to translate extra modules, we choosed to host our project on `Transifex`_. Subscribe
and join our `project-page`_. You must join a translation team to be able to translate.

* Go to ``Administration->Translations->Import/Export->Export translation``.
* Select the language you want to create, and ``PO File`` as file type.
If the team doesn't exist yet, `contact me`_.

The translation should be integrated into the next version, but you can download the ``.po`` file manually
to enable it on you current version.

.. _Transifex:
.. _project-page: https://www.transifex.net/projects/p/openerp-rent/
.. _contact me: mailto:thibaut.dirlik@gmail.com

Make bug reports
----------------

If you encounter bugs, you must report them. This is done easily on the `github project page`_.

.. _github project page: https://github.com/WE2BS/openerp-rent/issues

Improve the code
----------------

If you are a developper, just fork the project on github and send me a pull request with your modifications.
If you are not sure, or have questions, send me a private message on github or open an new issue.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ Currently, OpenERP Rent is only compatible with OpenERP 6.0 (but should be porte
install
configure
use
contribute
File renamed without changes.

0 comments on commit 1b30a53

Please sign in to comment.