diff --git a/README.md b/README.md index 8c43209c..e9edeb87 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ ![alt text](https://opnsense.org/wp-content/themes/OPNsense/assets/img/opnsense.png "Logo Title Text 1") # OPNsense documentation + Welcome to the OPNsense documentation & wiki. The purpose of this project is to provide OPNsense users with quality documentation. ## Contribute + You can contribute to the project in many ways, e.g. testing functionality, sending in bug reports or creating pull requests directly via GitHub. Any help is always very welcome! ## License + OPNsense documentation is available under the 2-Clause BSD license: 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. #### 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 @@ -43,37 +54,42 @@ executed using: ./collect_api_endpoints.py --repo plugins /path/to/plugins/repository ``` - #### Generate HTML documents + ``` make html ``` (```make clean``` to flush) - #### Changing theme + * Install Sass (http://sass-lang.com/). On macOS, this is done via ```/Library/Ruby/Gems``` + ``` gem install --no-user-install sass ``` + * Install npm (https://www.npmjs.com/get-npm) * Install Bower (https://bower.io/) + ``` npm install -g bower ``` - Install required stylesheets using bower + ``` bower install wyrm bower install robotoslab-googlefont bower install inconsolata-googlefont bower install font-awesome#4.7.0 ``` -(for font-awesome, choose newest) +(for font-awesome, choose newest) #### 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 +```