mirror of
https://github.com/acemod/ACE3.git
synced 2024-08-30 18:23:18 +00:00
Update documentation development environment instructions
This commit is contained in:
parent
986ac43a68
commit
b22a4bee60
2
docs/.gitignore
vendored
2
docs/.gitignore
vendored
@ -12,6 +12,8 @@ Thumbs.db
|
|||||||
.rbenv-version
|
.rbenv-version
|
||||||
.rvmrc
|
.rvmrc
|
||||||
|
|
||||||
|
npm-debug.log
|
||||||
|
|
||||||
addons
|
addons
|
||||||
CNAME
|
CNAME
|
||||||
|
|
||||||
|
@ -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/
|
### Installing prerequisites
|
||||||
5. Install bundler gem: Open a CLI and run `gem install bundler`
|
|
||||||
6. `cd` to the repo directory
|
|
||||||
7. Execute `bundle install`
|
|
||||||
|
|
||||||
**To run Jekyll:**
|
#### Windows (CMD)
|
||||||
|
|
||||||
```powershell
|
- Install [Ruby 2.0.0-p648 (x64)](http://rubyinstaller.org/downloads/)
|
||||||
bundle exec jekyll serve --future --incremental --config _config_dev.yml
|
- Install [Ruby DevKit for 2.0 (x64)](http://rubyinstaller.org/downloads/)
|
||||||
```
|
- Open Command Prompt and navigate to this directory
|
||||||
Then navigate to http://localhost:4000
|
```
|
||||||
|
cd <ACE3_directory>/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/
|
- Open Bash and navigate to this directory
|
||||||
2. Open a CLI and `cd` to the `src` directory
|
```
|
||||||
3. Run `npm install`
|
cd <ACE3_directory>/docs
|
||||||
4. Run `grunt`
|
```
|
||||||
|
- 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 <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
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user