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 and cd into it.
2. You'll need recent versions of node and npm to run Grunt
3. Run npm install to install the grunt modules.

Building the documentation

For now, grunt is only used to build the documentation. Run grunt watch to update the documentation and rebuild it automatically when JS files are edited/added/deleted.

The documentation lives in ./docs/.