Commit f4a56b27 authored by Remi Rampin's avatar Remi Rampin

Update setup instructions

parent 5e17f8e9
Pipeline #61082170 passed with stage
in 2 minutes and 36 seconds
......@@ -55,8 +55,9 @@ You can also install from a local clone of this repository, which will allow you
2. Navigate on the command line to the repository you've just cloned locally, using the ``cd`` command. To get help using ``cd``, use `this tutorial <https://swcarpentry.github.io/shell-novice/02-filedir/index.html>`__.
3. Taguette uses `Poetry <https://poetry.eustace.io/>`__ for its packaging and dependency management. You will need to `install Poetry <https://poetry.eustace.io/docs/#installation>`__
4. Install Taguette and its dependencies by running ``poetry install``. We recommend you run this inside of a `virtualenv <https://docs.python-guide.org/dev/virtualenvs/>`__ if possible.
5. You can start taguette in development mode using ``taguette --debug`` (or ``taguette --debug server <config_file>``). This will start Tornado in debug mode, which means in particular that it will auto-restart every time you make changes.
6. Navigate to `localhost:7465 <http://localhost:7465/>`__ to use Taguette!
5. (optional) Build translation files using ``scripts/update_translations.sh``.
6. You can start taguette in development mode using ``taguette --debug`` (or ``taguette --debug server <config_file>``). This will start Tornado in debug mode, which means in particular that it will auto-restart every time you make changes.
7. Navigate to `localhost:7465 <http://localhost:7465/>`__ to use Taguette!
Getting Started
---------------
......
* Update CHANGELOG and version numbers
* Create a signed tag (git tag -s)
* Update translation files (scripts/update_translations.sh)
* Build sdist / bdist_wheel, upload to PyPI (with Twine)
* Buid MacOS installer (using macos.sh)
* Build Windows installer (using pyinstaller_entrypoint.py and windows.spec, then windows-installer.iss)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment