X-Git-Url: http://git.openwrt.org/?a=blobdiff_plain;f=README;h=43791397cd97c67d7627b725fe4d908a64c7a28d;hb=0da6f8ddc86b1bee176b0a15cb1bf7e200d61d00;hp=6cb96c65eb28082902dd289924126eb205d55ca9;hpb=b089afc5f2b5e64f285503aa03307b9651063e21;p=web.git diff --git a/README b/README index 6cb96c6..4379139 100644 --- a/README +++ b/README @@ -6,10 +6,19 @@ All pages should follow these rules * changes are verified using aspell * changes to the rules.txt files are not allowed without a prior vote -Top level pages are in in pages/ sub-folder. -The "Documentation" subsection is in the docs/ sub-folder. +Top level pages are located in this directory while the "Documentation" +can be found in the docs/ sub-folder. -The website is generated from asciidoc using a cron script. If you update the script tell someone with access to the web server so that the script run is synced with the one in the tree. +The website is generated from asciidoc using jekyll invoked by a cron script +every 15 minutes. + +If sources are updated to require new jekyll plugins or a changed configuration +then tell someone with access to the web server so that the settings can be +synchronized with those in the tree. + +In order to generate the pages locally for testing your changes, +install https://jekyllrb.com/, issue "jekyll serve" and navigate to +http://127.0.0.1:4000/ with your browser. LICENSE is TBD and should be placed in the LICENSE file once decided.