Skip to content

Commit

Permalink
Update instructions (#14) (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
albertov19 authored Sep 11, 2024
1 parent a36572c commit f44416e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ pip install -r requirements.txt

## Getting Started

With the dependencies installed, you can proceed to clone the necessary repos. For everything to work correctly, the file structure needs to be as follows:
For everything to work correctly, the file structure needs to be as follows:

```text
wormhole-mkdocs
|--- /material-overrides/ (folder)
|--- /wormhole-docs/ (repository)
|--- /wormhole-docs/ (submodule)
|--- mkdocs.yml
```

Expand All @@ -36,11 +36,11 @@ To set up the structure, follow these steps:
git clone https://github.com/papermoonio/wormhole-mkdocs
```

2. Inside the folder just created, clone the [wormhole-docs repository](https://github.com/wormhole-foundation/wormhole-docs):
2. Inside the folder just created, initialize and update the [wormhole-docs repository](https://github.com/wormhole-foundation/wormhole-docs):

```bash
cd wormhole-mkdocs
git clone https://github.com/wormhole-foundation/wormhole-docs.git
git submodule init && git submodule update
```

3. In the `wormhole-mkdocs` folder (which should be the current one), you can build the site by running:
Expand Down

0 comments on commit f44416e

Please sign in to comment.