Skip to content

Commit

Permalink
Merge pull request #89 from linea-it/carlosadean-patch-2
Browse files Browse the repository at this point in the history
Update clone and run instructions
  • Loading branch information
carlosadean authored Sep 10, 2024
2 parents a6d5fad + c757919 commit 7a25f3e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,24 @@ If you need any further assistance send an email to `[email protected]`.

# How to build the documentation

**1. Clone the repo**
```
git clone https://github.com/linea-it/docs/
cd docs
```

**2. Create the python virtual env and intall all packages**
```
apt-get install python-pip python3.10-venv
python3 -m venv mkdocs
source mkdocs/bin/activate
pip install -r requirements.txt
pip install -r docs/requirements.txt
```

To run a local server using mkdocs:

```
cd docs
source mkdocs/bin/activate
source mkdocs/bin/activate # if not loaded
mkdocs serve
```

Expand Down

0 comments on commit 7a25f3e

Please sign in to comment.