diff --git a/README.md b/README.md index 8f461e3..475b902 100644 --- a/README.md +++ b/README.md @@ -69,13 +69,13 @@ Requirements: - **Python 3.9+** - PostgreSQL (tested using 9.6+), SQL knowledge is recommended. - gifsicle for GIF emoji and avatar handling -- [pipenv] +- [poetry] Optional requirement: - [mediaproxy] -[pipenv]: https://github.com/pypa/pipenv +[poetry]: https://python-poetry.org/ [mediaproxy]: https://gitlab.com/litecord/mediaproxy ### Download the code @@ -87,7 +87,7 @@ $ git clone https://gitlab.com/litecord/litecord.git && cd litecord ### Install packages ```sh -$ pipenv install --dev +$ poetry install ``` ### Setting up the database @@ -110,7 +110,7 @@ $ $EDITOR config.py Then, you should run database migrations: ```sh -$ pipenv run ./manage.py migrate +$ poetry run ./manage.py migrate ``` ## Running @@ -120,7 +120,7 @@ This will expose your Litecord instance to the world. You can use the `-b` option to change it (e.g. `-b 0.0.0.0:45000`). ```sh -$ pipenv run hypercorn run:app +$ poetry run hypercorn run:app ``` You can use `--access-log -` to output access logs to stdout. @@ -145,7 +145,7 @@ Update the code and run any new database migrations: ```sh $ git pull -$ pipenv run ./manage.py migrate +$ poetry run ./manage.py migrate ``` ## Running tests diff --git a/docs/operating.md b/docs/operating.md index b30fe3f..63c057d 100644 --- a/docs/operating.md +++ b/docs/operating.md @@ -8,7 +8,7 @@ may be moved to the Admin API without proper notice. There is no frontend yet for the Admin API. The possible actions on `./manage.py` can be accessed via `./manage.py -h`, or -`pipenv run ./manage.py -h` if you're on pipenv. +`poetry run ./manage.py -h` if you're on poetry (recommended). ## `./manage.py generate_token`? @@ -31,4 +31,4 @@ user flags, also gives complete access over the Admin API. Only make staff the people you (the instance OP) can trust. Use the `./manage.py make_staff` management task to make someone staff. There is -no way to remove someone's staff with a `./manage.py` command *yet.* +no way to remove someone's staff with a `./manage.py` command _yet._