Archives
/
opensense-docs
mirror of https://github.com/opnsense/docs
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

README: update instructions for FreeBSD

Browse Source
pull/302/head
Franco Fichtner 3 years ago
parent 5ed7abbdfb
commit b65a761bed
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File

28
README.md
Unescape Escape View File

@ -1,15 +1,18 @@
![alt text](https://opnsense.org/wp-content/themes/OPNsense/assets/img/opnsense.png "Logo Title Text 1") ![alt text](https://opnsense.org/wp-content/themes/OPNsense/assets/img/opnsense.png "Logo Title Text 1")
# OPNsense documentation # OPNsense documentation
Welcome to the OPNsense documentation & wiki. Welcome to the OPNsense documentation & wiki.
The purpose of this project is to provide OPNsense users with quality documentation. The purpose of this project is to provide OPNsense users with quality documentation.
## Contribute ## Contribute
You can contribute to the project in many ways, e.g. testing You can contribute to the project in many ways, e.g. testing
functionality, sending in bug reports or creating pull requests functionality, sending in bug reports or creating pull requests
directly via GitHub. Any help is always very welcome! directly via GitHub. Any help is always very welcome!
## License ## License
OPNsense documentation is available under the 2-Clause BSD license: OPNsense documentation is available under the 2-Clause BSD license:
http://opensource.org/licenses/BSD-2-Clause http://opensource.org/licenses/BSD-2-Clause
@ -28,9 +31,17 @@ license of these rights. Deciso B.V. does not represent or make any warranties
that it owns or licenses any of the mentioned, nor does it grant them. that it owns or licenses any of the mentioned, nor does it grant them.
#### Prepare build #### Prepare build
Install Sphinx, our default theme and contrib packages
On FreeBSD the following packages are required:
``` ```
pip3 install -r requirements.txt --upgrade pkg install py37-pip jpeg-turbo gmake
```
Install Sphinx, our default theme and contrib packages:
```
pip install -r requirements.txt --upgrade
``` ```
### Update API endpoints ### Update API endpoints
@ -43,37 +54,42 @@ executed using:
./collect_api_endpoints.py --repo plugins /path/to/plugins/repository ./collect_api_endpoints.py --repo plugins /path/to/plugins/repository
``` ```
#### Generate HTML documents #### Generate HTML documents
``` ```
make html make html
``` ```
(```make clean``` to flush) (```make clean``` to flush)
#### Changing theme #### Changing theme
* Install Sass (http://sass-lang.com/). On macOS, this is done via ```/Library/Ruby/Gems``` * Install Sass (http://sass-lang.com/). On macOS, this is done via ```/Library/Ruby/Gems```
``` ```
gem install --no-user-install sass gem install --no-user-install sass
``` ```
* Install npm (https://www.npmjs.com/get-npm) * Install npm (https://www.npmjs.com/get-npm)
* Install Bower (https://bower.io/) * Install Bower (https://bower.io/)
``` ```
npm install -g bower npm install -g bower
``` ```
Install required stylesheets using bower Install required stylesheets using bower
``` ```
bower install wyrm bower install wyrm
bower install robotoslab-googlefont bower install robotoslab-googlefont
bower install inconsolata-googlefont bower install inconsolata-googlefont
bower install font-awesome#4.7.0 bower install font-awesome#4.7.0
``` ```
(for font-awesome, choose newest)
(for font-awesome, choose newest)
#### Build your theme: #### Build your theme:
``` ```
sass -I bower_components/wyrm/sass/ -I bower_components/bourbon/dist/ -I bower_components/neat/app/assets/stylesheets/ -I bower_components/font-awesome/scss/ themes/opnsense/sass/theme.sass > source/_static/css/opnsense.css sass -I bower_components/wyrm/sass/ -I bower_components/bourbon/dist/ -I bower_components/neat/app/assets/stylesheets/ -I bower_components/font-awesome/scss/ themes/opnsense/sass/theme.sass > source/_static/css/opnsense.css
```

Write Preview
Loading…
Cancel
Save