Update README

This commit is contained in:
Hartmut Goebel
2023-06-09 09:28:59 +02:00
parent 5b53300280
commit 43d88d67fe
+41 -12
View File
@@ -1,23 +1,52 @@
This repository contains all the packages of Tryton.
######
Tryton
######
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.
update.modules = .hooks/link_modules
This repository contains the source for all the packages of Tryton.
To automatically generate requirements files on Mercurial update, add
the following line to the hooks section of your .hg/hgrc:
Setup
=====
update.requirements = .hooks/update_requirements
It is recommended to isolate the development within a Python `virtual
environment <https://docs.python.org/tutorial/venv.html>`_.
From the root directory of the repository run:
.. code-block:: console
.hooks/update_requirements
.hooks/link_modules
.. warning::
The process of updating requirements files may take some time
The process of updating requirements files may take some time.
Then you can install the required dependencies with:
Install the dependencies with:
pip install -r requirements.txt
.. code-block:: console
And you can also install the development dependencies with:
pip install -e trytond -e tryton -e proteus -r requirements.txt -r requirements-dev.txt
pip install -r requirements-dev.txt
Automate
========
To automate the process, add the following lines to the ``[hooks]`` section of
the ``.hg/hgrc``:
.. code-block:: ini
[hooks]
update.modules = .hooks/link_modules
update.requirements = .hooks/update_requirements
On ``hg update``, the first hook will automatically create symlinks for modules
and the second hook will automatically generate requirements files.
Submit Change
=============
For information about how to submit change, please read on and follow the
`guidelines <https://www.tryton.org/develop>`_.