Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jwsi committed May 7, 2020
1 parent 53ccf5b commit 045898b
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,30 @@ Open-source issue tracker and documentation hub for [UH VPN](https://uh-vpn.com)

Head over to [issues](https://github.com/ultrahorizon/UH-VPN-Docs/issues/new/choose) and create a new one by using one of the pre-made templates to describe your question/bug/request.
Our development team aim to respond within two days.

## Building the docs locally

- Clone the repo:

```bash
$> git clone git@github.com:ultrahorizon/UH-VPN-Docs.git
```

- Install a Python 3.7 virtualenv inside the root of the repository folder:

```bash
$> virtualenv --python=python3.7 .
```

- Install Python dependencies:

```bash
$> pip install -r requirements.txt
```

- Build the docs and view the output in the generated `build` directory:

```bash
$> make html
```

0 comments on commit 045898b

Please sign in to comment.