Welcome to emuStudio website!

The website is built using GitHub pages, using Jekyll static site generator.

License

The website is released under Apache 2.0. The website uses Jekyll templates which might be released under different licenses:

• just-the-docs
• scotch-io

Setting up the environment

The website, user documentation and developer documentation are separate Jekyll sites. Dependencies of all three are maintained separately, in files:

• Root Gemfile for the website,
• _documentation/user/Gemfile
• _documentation/developer/Gemfile

It is good to have installed bundle application on your machine. Then, run the following command in each location where Gemfile is present:

bundle install

After successful execution, the website can be served locally with command:

bundle exec jekyll s

Then, navigate the browser to http://localhost:4000/.

Building the website

In order to build a production version of the site, run the build script:

build.sh

This will generate _site directory where you can find production version of the website along with the documentation. If you like to generate just user/developer documentation, run separate build scripts:

• _documentation/user/build.sh to generate user documentation
• _documentation/developer/build.sh to generate developer documentation

Both documentations are generated into documentation directory. This directory must be committed to git, since the documentation won't be processed by GitHub pages, just the website.

Tools

• Logo: MetaPost
• Screenshot editing (markup): Shutter
• Animated gif:
  • peek: for bitmap gifs
  • asciinema, agg: for terminal gifs
    • ./agg --theme asciinema reverse.cast reverse.gif
• Thumbnails: imagemagick