Skip to content

Commit b49f448

Browse files
committed
update README
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
1 parent 26c01fc commit b49f448

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ project.
1212
- [Good to Have](#good-to-have)
1313
- [Installation and Usage](#installation-and-usage)
1414
- [Install the dependencies](#install-the-dependencies)
15+
- [Using the `requirements.txt` file](#using-the-requirementstxt-file)
1516
- [Register for Google Recaptcha](#register-for-google-recaptcha)
1617
- [Optionally add Google Analytics](#optionally-add-google-analytics)
1718
- [Set up the .env file](#set-up-the-env-file)
@@ -113,18 +114,46 @@ From the root of the checked-out repository:
113114

114115
### Install the dependencies
115116

116-
I have switched over to using [Poetry](https://python-poetry.org/) to have much
117+
I have switched over to using [uv](https://docs.astral.sh/uv/) to have much
117118
better control of Dependencies. Please make sure that it is installed globally
118119
before continuing.
119120

120121
```terminal
121-
poetry install
122-
poetry shell
122+
uv sync
123+
source .venv/bin/activate
123124
```
124125

125126
This will install all the dependencies and switch to a virtual environment ready
126127
to use the app.
127128

129+
#### Using the `requirements.txt` file
130+
131+
If you prefer to use the `requirements.txt` file, or cannot use `uv` for some
132+
reason, you can install the dependencies using `pip`:
133+
134+
```bash
135+
pip install -r requirements.txt
136+
```
137+
138+
This will install all the required packages for the application. This may be
139+
required for hosting services that do not support `uv` or similar.
140+
141+
If you are developing, you may want to install the `dev-requirements.txt` file
142+
instead.
143+
144+
```bash
145+
pip install -r requirements-dev.txt
146+
```
147+
148+
> [!NOTE]
149+
>
150+
> The above 2 commands are ONLY required if you are NOT using `uv` to manage the
151+
> dependencies.
152+
>
153+
> Both the `requirements.txt` and `requirements-dev.txt` files are generated by
154+
> the pre-commit hooks, so they should always be up to date with the current
155+
> dependencies.
156+
128157
### Register for Google Recaptcha
129158

130159
The Comment system is protected using a `Recaptcha` to help avoid bots.

0 commit comments

Comments
 (0)