upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-02-18 18:17:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md - Update build process on FreeBSD 14 (#619)

Browse source 
* Update README.md

* Update README.md

Remove exact FreeBSD version

---------

Co-authored-by: tinyboxvk <tinyboxvk@users.noreply.github.com>
This commit is contained in:
tinyboxvk 2024-12-08 14:10:23 -04:00 committed by GitHub
parent b25dda6c00
commit da2bf2c8d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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
@ -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
@ -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
```
```