Cédric Krier pushed to branch branch/default at Tryton / Tryton
Commits: a7fe7465 by Hartmut Goebel at 2023-06-09T09:28:59+02:00 Update README - - - - - 1 changed file: - README.rst Changes: ===================================== README.rst ===================================== @@ -1,2 +1,4 @@ -This repository contains all the packages of Tryton. +###### +Tryton +###### @@ -2,4 +4,6 @@ -To have symlinks for modules created automatically on Mercurial update, add -the following line to the hooks section of your .hg/hgrc: +Tryton is business software, ideal for companies of any size, easy to use, +complete and 100% Open Source. + +This repository contains the source for all the packages of Tryton. @@ -5,3 +9,7 @@ - update.modules = .hooks/link_modules +Setup +===== + +It is recommended to isolate the development within a Python `virtual +environment <https://docs.python.org/tutorial/venv.html>`_. @@ -7,4 +15,3 @@ -To automatically generate requirements files on Mercurial update, add -the following line to the hooks section of your .hg/hgrc: +From the root directory of the repository run: @@ -10,5 +17,8 @@ - update.requirements = .hooks/update_requirements +.. code-block:: console + + .hooks/update_requirements + .hooks/link_modules .. warning:: @@ -12,5 +22,9 @@ .. warning:: - The process of updating requirements files may take some time + The process of updating requirements files may take some time. + +Install the dependencies with: + +.. code-block:: console @@ -16,3 +30,9 @@ -Then you can install the required dependencies with: + pip install -e trytond -e tryton -e proteus -r requirements.txt -r requirements-dev.txt + +Automate +======== + +To automate the process, add the following lines to the ``[hooks]`` section of +the ``.hg/hgrc``: @@ -18,3 +38,7 @@ - pip install -r requirements.txt +.. code-block:: ini + + [hooks] + update.modules = .hooks/link_modules + update.requirements = .hooks/update_requirements @@ -20,3 +44,4 @@ -And you can also install the development dependencies with: +On ``hg update``, the first hook will automatically create symlinks for modules +and the second hook will automatically generate requirements files. @@ -22,2 +47,6 @@ - pip install -r requirements-dev.txt +Submit Change +============= + +For information about how to submit change, please read on and follow the +`guidelines <https://www.tryton.org/develop>`_. View it on Heptapod: https://foss.heptapod.net/tryton/tryton/-/commit/a7fe746585b665c56ad66f2a9f4eccf9bc1df0b2 -- View it on Heptapod: https://foss.heptapod.net/tryton/tryton/-/commit/a7fe746585b665c56ad66f2a9f4eccf9bc1df0b2 You're receiving this email because of your account on foss.heptapod.net.
