Commit 873f1a643f8d6446c353887cc6c8877c577ca7ed
1 parent
d66d01d8
Exists in
master
Update README.md with new build instructions
Signed-off-by: Carlos Coêlho <carlospecter@gmail.com> Signed-off-by: Arthur Jahn <stutrzbecher@gmail.com>
Showing
1 changed file
with
16 additions
and
16 deletions
Show diff stats
README.md
| ... | ... | @@ -6,28 +6,28 @@ The Noosfero theme that uses the API to create a totally new client-side fronten |
| 6 | 6 | |
| 7 | 7 | ### If you use Vagrant |
| 8 | 8 | Use our [VirtualBox](https://atlas.hashicorp.com/paulohtfs/boxes/noosfero-dev) with everything setup. |
| 9 | -Run: | |
| 10 | -``` | |
| 11 | - vagrant init paulohtfs/noosfero-dev | |
| 12 | - vagrant up --provider virtualbox | |
| 13 | - vagrant ssh | |
| 9 | +Run: | |
| 10 | +``` | |
| 11 | +vagrant up | |
| 12 | +vagrant ssh | |
| 14 | 13 | ``` |
| 15 | 14 | This box provides Noosfero and the Angular base theme repositories. |
| 16 | 15 | We've also set up vim and tmux to make the work easier. |
| 17 | 16 | |
| 18 | 17 | ### How to Install |
| 19 | 18 | 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) |
| 20 | -1. Install [Bower](http://bower.io/): `npm install -g bower` | |
| 21 | -1. Install [Gulp](http://gulpjs.com/): `npm install -g gulp` | |
| 22 | -1. Install Node.js dependencies: `npm install` | |
| 23 | -1. Install bower dependencies: `bower install` | |
| 24 | -1. Build the project: `npm run build` | |
| 25 | -1. Run project tests: `npm run test` | |
| 19 | +2. Install [Bower](http://bower.io/): `npm install -g bower` | |
| 20 | +3. Install [Gulp](http://gulpjs.com/): `npm install -g gulp` | |
| 21 | +4. Install Node.js dependencies: `npm install` | |
| 22 | +5. Install bower dependencies: `bower install` | |
| 23 | +6. Build the project: `npm run build` | |
| 24 | +7. Build multiple themes: `npm run build-all` | |
| 25 | +8. Run project tests: `npm run test` | |
| 26 | 26 | |
| 27 | 27 | ### How to Use |
| 28 | 28 | |
| 29 | -Just set the profile theme to `angular-theme`. | |
| 30 | - | |
| 29 | +Copy the desired theme from the `dist` folder into | |
| 30 | +noosfero `public/design/themes`. | |
| 31 | 31 | |
| 32 | 32 | ## Project Structure |
| 33 | 33 | The folder structure of this project was sorted by feature. |
| ... | ... | @@ -45,8 +45,8 @@ See some important folders bellow: |
| 45 | 45 | ## Change theme |
| 46 | 46 | |
| 47 | 47 | 1. Create the theme folder inside themes |
| 48 | -1. Configure application to use the new theme, e.g.: | |
| 48 | +2. Configure application to use the new theme, e.g.: | |
| 49 | 49 | `npm config set angular-theme:theme custom-theme` |
| 50 | -1. Create an app folder inside custom-theme and add your custom scss files | |
| 51 | -1. Put the templates that you want to override in the same structure from the main application source, e.g.: | |
| 50 | +3. Create an app folder inside custom-theme and add your custom scss files | |
| 51 | +4. Put the templates that you want to override in the same structure from the main application source, e.g.: | |
| 52 | 52 | `src/app/profile/profile.html` will be overriden by `themes/custom-theme/app/profile/profile.html` | ... | ... |