StoryWriter

A project that aims to provide software for story writers.

This project is intended to, in order of listing, provide the contributors with software engineering experience, teamwork experience, and to produce a program that aids in the story writing process.

Contributing Guide

In order to preview documentation it is necessary to install the Gitbook command line interface and execute some commands.

1. Gitbook CLI Installation

    $ npm install -g gitbook-cli
   

2. Change to documentation directory

    $ cd docs
   

3. Install gitbook

    $ gitbook install
   

4. Build and start local gitbook

    $ gitbook serve
   

5. Check documentation in http://localhost:4000