Skip to content

Commit

Permalink
Update README.md - Update build process on FreeBSD 14 (#619)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

Remove exact FreeBSD version

---------

Co-authored-by: tinyboxvk <[email protected]>
  • Loading branch information
tinyboxvk and tinyboxvk authored Dec 8, 2024
1 parent b25dda6 commit da2bf2c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ directly via GitHub. Any help is always very welcome!

OPNsense documentation is available under the 2-Clause BSD license:

http://opensource.org/licenses/BSD-2-Clause
https://opensource.org/licenses/BSD-2-Clause

Every contribution made to the project must be licensed under the
same conditions in order to keep OPNsense truly free and accessible
Expand All @@ -35,13 +35,13 @@ that it owns or licenses any of the mentioned, nor does it grant them.
On FreeBSD the following packages are required:

```
pkg install py39-pip jpeg-turbo gmake
pkg install python py311-pip jpeg-turbo gmake
```

Install Sphinx, our default theme and contrib packages:

```
pip[3] install -r requirements.txt --upgrade
pip install -r requirements.txt --upgrade
```

### Update API endpoints
Expand All @@ -57,17 +57,17 @@ executed using:
#### Generate HTML documents

```
make html
gmake html
```

(```make clean``` to flush)
(```gmake clean``` to flush)

#### Live preview of HTML documents

Use `sphinx-autobuild` to track `source` for changes and get a live preview served via ``http://localhost:8000``.

```
pip[3] install sphinx-autobuild
pip install sphinx-autobuild
```

```
Expand Down

0 comments on commit da2bf2c

Please sign in to comment.