couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robertkowal...@apache.org
Subject [1/2] fauxton commit: updated refs/heads/master to f72e034
Date Fri, 19 Sep 2014 17:13:47 GMT
Repository: couchdb-fauxton
Updated Branches:
  refs/heads/master 63d7ecb27 -> f72e034fa


minor README update to mention grunt-cli


Project: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/commit/c5c4d9d8
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/tree/c5c4d9d8
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/diff/c5c4d9d8

Branch: refs/heads/master
Commit: c5c4d9d8b864462181e3a60105db40c1fc10a754
Parents: 63d7ecb
Author: Benjamin Keen <ben.keen@gmail.com>
Authored: Thu Sep 18 11:01:34 2014 -0700
Committer: Robert Kowalski <rok@kowalski.gd>
Committed: Fri Sep 19 19:11:38 2014 +0200

----------------------------------------------------------------------
 readme.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/blob/c5c4d9d8/readme.md
----------------------------------------------------------------------
diff --git a/readme.md b/readme.md
index 9ecd564..a48d0b8 100644
--- a/readme.md
+++ b/readme.md
@@ -20,6 +20,16 @@ A recent of [node.js](http://nodejs.org/) and npm is required.
     4. npm install
 
 
+### Install the grunt-cli
+In case you don't have the grunt command line interface installed, run the following command:
+
+    npm install -g grunt-cli
+
+If you run into a permissions problem, run that last command as an administrator:
+
+    sudo npm install -g grunt-cli
+
+
 ### NOTE: Before you run fauxton, don't forget to start couchdb!
 
 ### Dev Server
@@ -32,7 +42,6 @@ And then...
 
 You should be able to access fauxton on `http://localhost:8000`
 
-
 ### Prepare Fauxton Release
     Follow the "Fauxton Setup" section,
     Edit settings.json variable root where the document will live.  eg.  "/_utils/fauxton/"
@@ -53,12 +62,14 @@ You should be able to access fauxton on `http://localhost:8000`
 
 ## Understanding the Fauxton Code layout
 
-Each bit of functionality is its own seperate module or addon. All core modules are stored
under `app/module` and any addons that are optional are under `app/addons`.
+Each bit of functionality is its own separate module or addon. All core modules are stored
under `app/module` and any addons that are optional are under `app/addons`.
 We use [backbone.js](http://backbonejs.org/) and [Backbone.layoutmanager](https://github.com/tbranyen/backbone.layoutmanager)
quite heavily, so best to get an idea how they work.
-Its best at this point to read through a couple of the modules and addons to get an idea
of how they work. Two good starting points are `app/addon/config` and `app/modules/databases`.
+It's best at this point to read through a couple of the modules and addons to get an idea
of how they work. Two good starting points are `app/addon/config` and `app/modules/databases`.
 Each module must have a `base.js` file, this is read and compile when Fauxton is deployed.
A `resource.js` file is usually for your Backbone.Models and Backbone.Collections,
 `view.js` for your Backbone.Views. The `routes.js` is used to register a url path for your
view along with what layout, data, breadcrumbs and api point is required for the view.
 
+Check out [writing_addons.md](writing_addons.md) for more information on writing your own
addons.
+
 ## Todo items
 
 Checkout [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406) for a list
of items to do.


Mime
View raw message