From 80ab584fa4bfa21bd4a8e3271a28ad49646d835f Mon Sep 17 00:00:00 2001 From: Philip Schatz Date: Thu, 9 Jan 2014 00:18:46 -0500 Subject: [PATCH 1/3] remove both readme files --- README.md | 45 --------------------------------------------- readme.md | 45 --------------------------------------------- 2 files changed, 90 deletions(-) delete mode 100644 README.md delete mode 100644 readme.md diff --git a/README.md b/README.md deleted file mode 100644 index 6fb236e..0000000 --- a/README.md +++ /dev/null @@ -1,45 +0,0 @@ -# Development and Building - -Below are instructions for building the book editor yourself and a layout -of how the code is organized. - -## Building Yourself - -1. Download and extract (if necessary) -2. Run `npm install` or just `bower install` in the directory to download and install dependencies -3. Start up a webserver - - -## Building Documentation - -Documentation is built using `docco`. - - find . -name "*.coffee" | grep -v './bower_components/' | grep -v './node_modules' | xargs ./node_modules/docco/bin/docco - -Check the `./docs` directory to read through the different modules. - -## Directory Layout - -* `scripts/collections/` Backbone Collections -* `scripts/configs/` App and 3rd party configs -* `scripts/controllers/` Marionette Controllers -* `scripts/helpers/` Miscellaneous helper functions -* `scripts/models/` Backbone Models and Marionette Modules -* `scripts/nls/` Internationalized strings -* `scripts/routers/` Marionette Routers -* `scripts/views/` Backbone and Marionette Views -* `scripts/views/layouts/` Marionette Layouts -* `scripts/app.coffee` Marionette Application -* `scripts/config.coffee` Requirejs Config -* `scripts/main.js` Initial Requirejs Loader -* `scripts/session.coffee` Model of Session -* `styles/` LESS and CSS Styling -* `templates/` Handlebars Templates -* `templates/helpers/` Handlebars Helpers -* `test/` Testable mock data and scripts -* `index.html` App's HTML Page - -License -------- - -This software is subject to the provisions of the GNU Affero General Public License Version 3.0 (AGPL). See license.txt for details. Copyright (c) 2013 Rice University diff --git a/readme.md b/readme.md deleted file mode 100644 index 6fb236e..0000000 --- a/readme.md +++ /dev/null @@ -1,45 +0,0 @@ -# Development and Building - -Below are instructions for building the book editor yourself and a layout -of how the code is organized. - -## Building Yourself - -1. Download and extract (if necessary) -2. Run `npm install` or just `bower install` in the directory to download and install dependencies -3. Start up a webserver - - -## Building Documentation - -Documentation is built using `docco`. - - find . -name "*.coffee" | grep -v './bower_components/' | grep -v './node_modules' | xargs ./node_modules/docco/bin/docco - -Check the `./docs` directory to read through the different modules. - -## Directory Layout - -* `scripts/collections/` Backbone Collections -* `scripts/configs/` App and 3rd party configs -* `scripts/controllers/` Marionette Controllers -* `scripts/helpers/` Miscellaneous helper functions -* `scripts/models/` Backbone Models and Marionette Modules -* `scripts/nls/` Internationalized strings -* `scripts/routers/` Marionette Routers -* `scripts/views/` Backbone and Marionette Views -* `scripts/views/layouts/` Marionette Layouts -* `scripts/app.coffee` Marionette Application -* `scripts/config.coffee` Requirejs Config -* `scripts/main.js` Initial Requirejs Loader -* `scripts/session.coffee` Model of Session -* `styles/` LESS and CSS Styling -* `templates/` Handlebars Templates -* `templates/helpers/` Handlebars Helpers -* `test/` Testable mock data and scripts -* `index.html` App's HTML Page - -License -------- - -This software is subject to the provisions of the GNU Affero General Public License Version 3.0 (AGPL). See license.txt for details. Copyright (c) 2013 Rice University From 2d139924c8827d0682897758b5a2d4d001d30eee Mon Sep 17 00:00:00 2001 From: Philip Schatz Date: Thu, 9 Jan 2014 00:19:17 -0500 Subject: [PATCH 2/3] add http-server --- package.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index ade173a..213b561 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "test": "test" }, "scripts": { + "server": "http-server .", "test": "echo \"Error: no test specified\" && exit 1", "print-mock-data": "node ./test/print-mock-data.js", "install": "bower install", @@ -19,7 +20,8 @@ "backbone": "~1.0", "jquery": "~1.8", "coffee-script": "~1.6", - "jasmine-node": "~1.10" + "jasmine-node": "~1.10", + "http-server": "~0.6.1" }, "devDependencies": { "docco": "~0.4.0" From 0cdc8d696ac87f90c7077adebd469ac93139e9b4 Mon Sep 17 00:00:00 2001 From: Philip Schatz Date: Thu, 9 Jan 2014 00:19:38 -0500 Subject: [PATCH 3/3] add read me with instructions for starting web server --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..28ebba7 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Development and Building + +Below are instructions for building the book editor yourself and a layout +of how the code is organized. + +## Building Yourself + +1. Download and extract (if necessary) +2. Run `npm install` or just `bower install` in the directory to download and install dependencies +3. Start up a webserver by running `npm run server` (uses `http-server`) + + +## Building Documentation + +Documentation is built using `docco`. + + find . -name "*.coffee" | grep -v './bower_components/' | grep -v './node_modules' | xargs ./node_modules/docco/bin/docco + +Check the `./docs` directory to read through the different modules. + +## Directory Layout + +* `scripts/collections/` Backbone Collections +* `scripts/configs/` App and 3rd party configs +* `scripts/controllers/` Marionette Controllers +* `scripts/helpers/` Miscellaneous helper functions +* `scripts/models/` Backbone Models and Marionette Modules +* `scripts/nls/` Internationalized strings +* `scripts/routers/` Marionette Routers +* `scripts/views/` Backbone and Marionette Views +* `scripts/views/layouts/` Marionette Layouts +* `scripts/app.coffee` Marionette Application +* `scripts/config.coffee` Requirejs Config +* `scripts/main.js` Initial Requirejs Loader +* `scripts/session.coffee` Model of Session +* `styles/` LESS and CSS Styling +* `templates/` Handlebars Templates +* `templates/helpers/` Handlebars Helpers +* `test/` Testable mock data and scripts +* `index.html` App's HTML Page + +License +------- + +This software is subject to the provisions of the GNU Affero General Public License Version 3.0 (AGPL). See license.txt for details. Copyright (c) 2013 Rice University