ACE3/docs
2016-08-26 12:55:49 -05:00
..
_includes [Docs] Update component dependencies 2016-08-22 15:10:27 +02:00
_layouts merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
_posts merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
css merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
img merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
js merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
squad merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
src merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
tools merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
wiki Wiki - Add link from missionmaker to framework for interaction menu 2016-08-26 12:55:49 -05:00
_config_dev.yml merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
_config.yml merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
.editorconfig merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
.gitattributes merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
.gitignore Update documentation development environment instructions 2016-08-18 20:45:39 +02:00
404.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
CNAME Create CNAME 2016-08-18 19:00:17 +02:00
favicon-32.png merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
favicon.png merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
Gemfile merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
Gemfile.lock merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
google38c2ed88459ce9b8.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
googlebd2887f5a38652f2.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
humans.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
index.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
news.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
README_DE.md 3.6.2 2016-07-14 14:51:46 +02:00
README_PL.md 3.6.2 2016-07-14 14:51:46 +02:00
README.md Update documentation development environment instructions 2016-08-18 20:45:39 +02:00
robots.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
sitemap.xml merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
team.md merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
version.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00

Source of http://ace3mod.com/

Setting up the development environment

Installing prerequisites

Windows (CMD)

  • Install Ruby 2.0.0-p648 (x64)
  • Install Ruby DevKit for 2.0 (x64)
  • Open Command Prompt and navigate to this directory
    cd <ACE3_directory>/docs
    
  • Install bundler gem
    gem install bundler
    
  • Install required gems through bundler
    bundle install
    

Debian / Bash on Ubuntu on Windows

  • Open Bash and navigate to this directory
    cd <ACE3_directory>/docs
    
  • Install make and gcc
    sudo apt-get make gcc
    
  • Install ruby 2.0, rbuy2.0-dev and ruby-switch
    sudo apt-add-repository ppa:brightbox/ruby-ng
    sudo apt update
    sudo apt install ruby2.0 ruby2.0-dev ruby-switch
    
  • Set Ruby version
    sudo ruby-switch --set ruby2.0
    
  • Install bundler
    sudo gem install bundler
    
  • Install required gems through bundler
    bundle install
    
  • In case of sticky folder error during bundle install, execute the following to fix permissions
    find ~/.bundle/cache -type d -exec chmod 0755 {} +
    

Running

  • Run Jekyll through bundler

    bundle exec jekyll serve --future --incremental --config _config_dev.yml
    

    Use --force_polling on Bash on Ubuntu on Windows due to a bug preventing watching.

  • Navigate to http://localhost:4000

Updating compiled JavaScript and CSS files

  • Install Node.js
  • Open Command Prompt and navigate to src directory
    cd <ACE3_directory>/docs/src
    
  • Install Node packages
    npm install
    
    On Bash on Ubuntu on Windows also install nodejs-legacy in case of errors.
  • Update files
    grunt