diff --git a/README.md b/README.md index 31a484c..eec69ba 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,28 @@ The Noosfero theme that uses the API to create a totally new client-side fronten ### If you use Vagrant Use our [VirtualBox](https://atlas.hashicorp.com/paulohtfs/boxes/noosfero-dev) with everything setup. -Run: -``` - vagrant init paulohtfs/noosfero-dev - vagrant up --provider virtualbox - vagrant ssh +Run: +``` +vagrant up +vagrant ssh ``` This box provides Noosfero and the Angular base theme repositories. We've also set up vim and tmux to make the work easier. ### How to Install 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) -1. Install [Bower](http://bower.io/): `npm install -g bower` -1. Install [Gulp](http://gulpjs.com/): `npm install -g gulp` -1. Install Node.js dependencies: `npm install` -1. Install bower dependencies: `bower install` -1. Build the project: `npm run build` -1. Run project tests: `npm run test` +2. Install [Bower](http://bower.io/): `npm install -g bower` +3. Install [Gulp](http://gulpjs.com/): `npm install -g gulp` +4. Install Node.js dependencies: `npm install` +5. Install bower dependencies: `bower install` +6. Build the project: `npm run build` +7. Build multiple themes: `npm run build-all` +8. Run project tests: `npm run test` ### How to Use -Just set the profile theme to `angular-theme`. - +Copy the desired theme from the `dist` folder into +noosfero `public/design/themes`. ## Project Structure The folder structure of this project was sorted by feature. @@ -45,8 +45,8 @@ See some important folders bellow: ## Change theme 1. Create the theme folder inside themes -1. Configure application to use the new theme, e.g.: +2. Configure application to use the new theme, e.g.: `npm config set angular-theme:theme custom-theme` -1. Create an app folder inside custom-theme and add your custom scss files -1. Put the templates that you want to override in the same structure from the main application source, e.g.: +3. Create an app folder inside custom-theme and add your custom scss files +4. Put the templates that you want to override in the same structure from the main application source, e.g.: `src/app/profile/profile.html` will be overriden by `themes/custom-theme/app/profile/profile.html` -- libgit2 0.21.2