diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca376c673..5d6842257 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,35 @@ bundle install env PORT=4001 yarn run dev ``` +### Windows + +1. Install **Ruby**: https://rubyinstaller.org/ + * After the installation check the box and type `3` to select the 3rd option + * Add `C:\msys64\usr\bin` to PATH env variable + * Add `C:\Ruby24-x64\bin` to PATH env variable +2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows +3. Install **jekyll** via command prompt: `gem install jekyll bundler` +4. Install **nodejs && npm**: https://nodejs.org/en/download/ +4. Install **webpack** via command prompt: `npm install -g webpack` +5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: +```bash +SETX HOMEDRIVE %SYSTEMDRIVE% -m +SETX HOMEPATH \Users\%username% -m +SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% +SETX HOME "%HOME%" +``` + +#### Start Jekyll and Webpack + +Go wherever the project's files are located and open a new command prompt, execute the below commands: + +```bash +yarn install +bundle install +SET PORT=4001 +yarn run dev +``` + ## CSS classes See for a reference on styling.