Skip to content

Commit c2f9b9b

Browse files
committed
docs: add submodule init to project setup documentation
1 parent 459a71d commit c2f9b9b

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,27 @@ 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+
3. Activate the virtualenv.
41+
4. Copy `local_settings.py.example` to `local_settings.py` and modify.
3942
Make sure to uncomment the appropriate database section (either sqlite or
4043
PostgreSQL).
41-
4. Migrate changes.
44+
5. Migrate changes.
4245

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

4750
uv run ./manage.py loaddata main/fixtures/*.json
4851
uv run ./manage.py loaddata devel/fixtures/*.json
4952
uv run ./manage.py loaddata mirrors/fixtures/*.json
5053
uv run ./manage.py loaddata releng/fixtures/*.json
51-
6. Use the following commands to start a service instance
54+
7. Use the following commands to start a service instance
5255

5356
uv run ./manage.py runserver
54-
7. To optionally populate the database with real data:
57+
8. To optionally populate the database with real data:
5558

5659
wget http://mirrors.kernel.org/archlinux/core/os/x86_64/core.db.tar.gz
5760
uv run ./manage.py reporead x86_64 core.db.tar.gz
@@ -62,7 +65,7 @@ probably want the following:
6265
Alter architecture and repo to get x86\_64 and packages from other repos if
6366
needed.
6467

65-
8. Database Updates for Added/Removed packages
68+
9. Database Updates for Added/Removed packages
6669

6770
sqlite3 archweb.db < packages/sql/update.sqlite3.sql
6871

0 commit comments

Comments
 (0)