Skip to content

Commit cb83f40

Browse files
docs: add submodule init to project setup documentation
dev: accept review changes Co-authored-by: Christian Heusel <christian@heusel.eu>
1 parent 459a71d commit cb83f40

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,28 @@ probably want the following:
3434
# Testing Installation
3535

3636
1. Run `uv sync`.
37-
2. Activate the virtualenv.
38-
3. Copy `local_settings.py.example` to `local_settings.py` and modify.
37+
2. Initialize git submodules:
38+
39+
git submodule update --init --recursive
40+
41+
3. Activate the virtualenv.
42+
4. Copy `local_settings.py.example` to `local_settings.py` and modify.
3943
Make sure to uncomment the appropriate database section (either sqlite or
4044
PostgreSQL).
41-
4. Migrate changes.
45+
5. Migrate changes.
4246

4347
uv run ./manage.py migrate
44-
5. Load the fixtures to pre populate some data. If you don't want some of the
48+
6. Load the fixtures to pre populate some data. If you don't want some of the
4549
provided data, adjust the file glob accordingly.
4650

4751
uv run ./manage.py loaddata main/fixtures/*.json
4852
uv run ./manage.py loaddata devel/fixtures/*.json
4953
uv run ./manage.py loaddata mirrors/fixtures/*.json
5054
uv run ./manage.py loaddata releng/fixtures/*.json
51-
6. Use the following commands to start a service instance
55+
7. Use the following commands to start a service instance
5256

5357
uv run ./manage.py runserver
54-
7. To optionally populate the database with real data:
58+
8. To optionally populate the database with real data:
5559

5660
wget http://mirrors.kernel.org/archlinux/core/os/x86_64/core.db.tar.gz
5761
uv run ./manage.py reporead x86_64 core.db.tar.gz
@@ -62,7 +66,7 @@ probably want the following:
6266
Alter architecture and repo to get x86\_64 and packages from other repos if
6367
needed.
6468

65-
8. Database Updates for Added/Removed packages
69+
9. Database Updates for Added/Removed packages
6670

6771
sqlite3 archweb.db < packages/sql/update.sqlite3.sql
6872

0 commit comments

Comments
 (0)