Skip to content

Commit

Permalink
README updates about merging feature banch
Browse files Browse the repository at this point in the history
  • Loading branch information
critmcdonald committed May 22, 2016
1 parent 982cab3 commit de10fd7
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,25 @@ Assets are now built using Grunt, which transpiles the SASS files and concatenat
To assist in development, the default Grunt task also:
* launches a local server at `http://localhost:8000/`
* starts `grunt-contrib-watch` to watch `index.html` and the .js files in `/source`
* Livereload is enabled if you are running the [browser extenstions](http://livereload.com/extensions/)]].
* Livereload is enabled if you are running the [browser extenstions](http://livereload.com/extensions/).

![screenshot](readme.png)

## Deploying

Statesman images, fonts, etc. are currently in the app so you'll need to follow the steps below to customize the app for your use:

1. Edit the settings file at `source/javascripts/settings.js`.
2. Add any fonts you'll need at `source/stylesheets/_fonts.scss`.
3. `npm install`
4. `gem install compass`
5. Run `grunt`
1. Add appropriate images to `source/images/`.
2. Edit the settings file at `source/javascripts/settings.js`.
3. Add any fonts you'll need at `source/stylesheets/_fonts.scss`.
4. `npm install`
5. `gem install compass`
6. Run `grunt`

A local server should open at `http://localhost:8000/` where you can use the tool locally.

We run the project through [GitHub pages](https://pages.github.com/) to allow access to the newsroom. We deploy this with `git push origin master:gh-pages`.

As of May 2016, we have been merging changes only into the statesman master branch, and have not been pulling any Vox changes in. So be careful if you merge in future changes ... I'm not sure what would happen. - @critmcdonald
As of May 2016, we have been merging changes only into the statesman master branch, and have not been pulling any Vox changes in. So if you work on a feature branch, **be careful with pull requests**. We merge using master as base, not Vox. - @critmcdonald

See the original repo at https://github.com/voxmedia/meme for additional info.

0 comments on commit de10fd7

Please sign in to comment.