Mercurial > p > roundup > code
comparison doc/installation.txt @ 7374:72de757edf78
issue2551220 - In installation.txt clarify source directory.
Added links to how to download source and added that testing only
works from source install.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 20 May 2023 12:19:54 -0400 |
| parents | 692242b3effd |
| children | deb8e7e6d66d |
comparison
equal
deleted
inserted
replaced
| 7373:5e9b0ff1c695 | 7374:72de757edf78 |
|---|---|
| 363 | 363 |
| 364 You can use the command ``deactivate`` to return to the normal | 364 You can use the command ``deactivate`` to return to the normal |
| 365 Python environment. However, for now continue with | 365 Python environment. However, for now continue with |
| 366 `configuring your first tracker`_. | 366 `configuring your first tracker`_. |
| 367 | 367 |
| 368 .. _downloaded and unpacked the source: | |
| 369 | |
| 368 Installing from downloaded source | 370 Installing from downloaded source |
| 369 --------------------------------- | 371 --------------------------------- |
| 370 | 372 |
| 371 In general you should be installing from a released Roundup version | 373 In general you should be installing from a released Roundup version |
| 372 into a virtual environment. | 374 into a virtual environment. |
| 2114 must have at least the rights to create and drop databases. | 2116 must have at least the rights to create and drop databases. |
| 2115 Documentation: details on `adding MySQL users`_, | 2117 Documentation: details on `adding MySQL users`_, |
| 2116 for PostgreSQL you want to call the ``createuser`` command with the | 2118 for PostgreSQL you want to call the ``createuser`` command with the |
| 2117 ``-d`` option to allow database creation. | 2119 ``-d`` option to allow database creation. |
| 2118 | 2120 |
| 2119 This can only be done if you downloaded and unpacked the source | 2121 This can only be done if you `install the source`_ distribution |
| 2120 distrbution. It will not work if you used `pip install` as the test | 2122 (steps 1-3) or from a `mercurial checkout |
| 2121 suite is not installed. Once you've unpacked roundup's source, if you | 2123 <../code.html#get-sources>`_. It will not work if you used `pip |
| 2122 have pytest installed, run ``python -m pytest test`` in the source | 2124 install` as the test suite is not installed. Once you've unpacked |
| 2123 directory and make sure there are no errors. If there are errors, | 2125 roundup's source, if you have pytest installed, run ``python -m |
| 2124 please let us know! | 2126 pytest test`` in the Roundup source directory and make sure there |
| 2127 are no errors. If there are errors, please let us know! | |
| 2125 | 2128 |
| 2126 .. _`user guide`: user_guide.html | 2129 .. _`user guide`: user_guide.html |
| 2127 .. _`roundup specification`: spec.html | 2130 .. _`roundup specification`: spec.html |
| 2128 .. _`tracker configuration`: reference.html#tracker-configuration | 2131 .. _`tracker configuration`: reference.html#tracker-configuration |
| 2129 .. _`customisation documentation`: customizing.html | 2132 .. _`customisation documentation`: customizing.html |