Skip to content

Commit

Permalink
Document required submodule initialization
Browse files Browse the repository at this point in the history
  • Loading branch information
m90 committed May 15, 2024
1 parent 71c2c17 commit ecfe1eb
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,23 @@ The status page is deployed to GitHub pages and will be built on each push to th

## Local development

__Important__: The `cstate` theme is distributed as a git submodule contained in this repository, and is not pulled by default.
To obtain the theme, you can either use `--recursive` when cloning:

```console
git clone --recursive [email protected]:wbstack/status-page.git
```

or init submodules from within the repository root

```console
git submodule update --init
```

To develop the site locally, use the existing [`docker compose`](https://docs.docker.com/compose/) setup.
Running

```
```console
docker compose up
```

Expand Down

0 comments on commit ecfe1eb

Please sign in to comment.