Skip to content

Commit 902e9fe

Browse files
committed
docs: update readme
1 parent 07976c4 commit 902e9fe

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,39 +20,34 @@ the [discord.py](https://pypi.org/project/discord.py/) library and [MongoDB](htt
2020
## Prerequisites
2121

2222
- Git
23-
- Python 3.8 or higher (tested on 3.12)
23+
- Python >= 3.8
24+
- [`uv` package manager](https://docs.astral.sh/uv/getting-started/installation/)
2425
- [MongoDB Atlas](https://www.mongodb.com/products/platform/atlas-database) or any other MongoDB instance
2526

2627
## Installation
2728

28-
1. Clone the repository
29+
1. Clone the repository.
2930

3031
```shell
31-
git clone https://github.com/nerva-project/RoboNerva.git
32+
git clone https://github.com/nerva-project/RoboNerva.git
3233
```
3334

34-
2. Switch to the project directory
35+
2. Switch to the project directory.
3536

3637
```shell
37-
cd RoboNerva
38+
cd RoboNerva
3839
```
3940

40-
3. Create a virtual environment
41+
3. Install the dependencies.
4142

4243
```shell
43-
python -m venv .venv
44+
uv sync --no-dev
4445
```
45-
46-
4. Activate the virtual environment
47-
48-
```shell
49-
source .venv/bin/activate
50-
```
51-
52-
5. Install the dependencies
46+
47+
4. (Optional) Set up a development environment by installing the development dependencies and extras.
5348

5449
```shell
55-
pip install .
50+
uv sync --all-extras
5651
```
5752

5853
## Configuration
@@ -62,11 +57,11 @@ Copy the [`config.example.py`](config.example.py) file to `config.py` and update
6257
## Running
6358

6459
```shell
65-
python launcher.py
60+
uv run launcher.py
6661
```
6762

6863
## License
6964

7065
[GNU General Public License v3.0](LICENSE)
7166

72-
Copyright © 2024 [Sayan "Sn1F3rt" Bhattacharyya](https://sn1f3rt.me), [The Nerva Project](https://nerva.one)
67+
Copyright © 2024 [Sayan "Sn1F3rt" Bhattacharyya](https://sn1f3rt.dev), [The Nerva Project](https://nerva.one)

0 commit comments

Comments
 (0)