From b7f3d3a245fa70446ae56889e772dd2bbf7af41f Mon Sep 17 00:00:00 2001 From: Victor Costa Date: Thu, 21 Jan 2016 14:41:55 -0300 Subject: [PATCH] Improve readme --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3fb7294..bbdf8c5 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,24 @@ The Noosfero theme that uses the API to create a totally new client-side fronten ### How to Install 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) -2. Install [Bower](http://bower.io/): `npm install -g bower` -3. Install Node.js dependencies: `npm install` -4. Install bower dependencies: `bower install` -5. Build the project: `gulp build` +1. Install [Bower](http://bower.io/): `npm install -g bower` +1. Install Node.js dependencies: `npm install` +1. Install bower dependencies: `bower install` +1. Build the project: `gulp build` ### How to Use Just set the profile theme to `angular-theme`. + + +## Project Structure +The folder structure of this project was sorted by feature. +See some important folders bellow: + +- Directives for blocks: `src/app/components/noosfero-blocks` +- Directives for articles: `src/app/components/noosfero-articles` +- Directives for activities: `src/app/components/noosfero-activities` +- Service to connect with Noosfero API: `src/app/components/noosfero` +- Content viewer controller: `src/app/content-viewer` +- Profile controller: `src/app/profile` +- Profile info controller: `src/app/profile-info` -- libgit2 0.21.2