Refactor: Getting Started

Introduction

This is a guide for installing and running the refactor version of GENtle. Bear in mind it is still at a very early development stage.

Installation

1. Clone the repo using git clone git@github.com:Synbiota/GENtle2.git gentle, cd into it and pull the refactor branch (git pull origin feature/refactor && git checkout feature/refactor).
2. You'll need recent versions of node and npm to run grunt (only used for building the documentation for now).
3. Run npm install to install the grunt modules.

Building the documentation

We use grunt to build the documentation in real time. Run grunt watch in the repo to update the documentation and rebuild it automatically when JS files are edited/added/deleted.

The documentation lives in ./docs/.