README.md

Build files for Hext's project website

This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License unless noted otherwise. See the section 'Licensing' of this readme.

These are the build files for Hext's project page hext.thomastrapp.com, which is hosted on Github Pages.

Build instructions

Dependencies: git, jekyll, doxygen, uglifyjs, cleancss

# optional: refresh the libhext C++ library documentation
# from Github's master branch
./scripts/refresh-libhext-documentation.sh jekyll/

# optional: minify and combine js and css assets
./scripts/minimize-js-css.sh jekyll/

# create new build located in jekyll/_site
cd jekyll/
jekyll build

To switch to non-minified/non-combined assets, edit jekyll/_config.yml and add or uncomment the option environment: development.

Licensing

This project includes work authored by third parties, which have their own respective licenses.

• Ace — Used as the code editor in the "Try Hext in your Browser!" section and as a highlighter for all code examples. BSD License.
• Semantic UI — Used as a CSS framework. MIT License.
• jQuery — Used as a dependency by Semantic UI. MIT License.
• Google Fonts — The font Lato is embedded in this project. Open Font License.
• ReconnectingWebSocket — Automatically reconnects to the websocket server at hextws.thomastrapp.com:8080 if the connection is lost. MIT License.

Everything else is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License. If the CC-BY-NC-4.0 license is too restrictive for your purposes, contact me, and we'll work something out.