diff --git a/docs/.gitignore b/docs/.gitignore index f4c1e706d9..3232b5a935 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -12,6 +12,8 @@ Thumbs.db .rbenv-version .rvmrc +npm-debug.log + addons CNAME diff --git a/docs/README.md b/docs/README.md index c787d0d79f..2da9667295 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,22 +1,82 @@ -http://ace3mod.com/ +# Source of http://ace3mod.com/ -### How to install Jekyll on your local machine: +## Setting up the development environment -1. Install Ruby http://rubyinstaller.org/downloads/ -5. Install bundler gem: Open a CLI and run `gem install bundler` -6. `cd` to the repo directory -7. Execute `bundle install` +### Installing prerequisites -**To run Jekyll:** +#### Windows (CMD) -```powershell -bundle exec jekyll serve --future --incremental --config _config_dev.yml -``` -Then navigate to http://localhost:4000 +- Install [Ruby 2.0.0-p648 (x64)](http://rubyinstaller.org/downloads/) +- Install [Ruby DevKit for 2.0 (x64)](http://rubyinstaller.org/downloads/) +- Open Command Prompt and navigate to this directory + ``` + cd /docs + ``` +- Install `bundler` gem + ``` + gem install bundler + ``` +- Install required gems through `bundler` + ``` + bundle install + ``` -### How to update the compiled Javascript and CSS files +#### Debian / Bash on Ubuntu on Windows -1. Install Node.js: https://nodejs.org/download/ -2. Open a CLI and `cd` to the `src` directory -3. Run `npm install` -4. Run `grunt` +- Open Bash and navigate to this directory + ``` + cd /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](https://nodejs.org/download/) +- Open Command Prompt and navigate to `src` directory + ``` + cd /docs/src + ``` +- Install Node packages + ``` + npm install + ``` + _On Bash on Ubuntu on Windows also install `nodejs-legacy` in case of errors._ +- Update files + ``` + grunt + ```