Update README.md and CONTRIBUTING.md files

2017-01-02 14:52:43 +00:00
parent 8b5a4fce28
commit b99594de79
2 changed files with 51 additions and 57 deletions
@@ -31,3 +31,39 @@ If you're feeling adventurous, you can become a Git & GitHub master with the [Gi
 ## .editorconfig

 You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings.
+
+---
+
+## Contributing as a non-developer/non-designer
+
+We're always looking for new [translations](#translations).
+
+Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated.
+
+## Contributing as a designer
+
+As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet!
+
+You'll need to install Node.js, Bower and Gulp.
+
+To get started you can do the following:
+
+1. Install Node.js and our dev dependencies.
+2. Run `gulp`
+3. Make your changes to the SCSS files in `./resources/assets/sass/`
+
+If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you!
+
+When you're happy with your changes, please run `gulp --production` to minify the assets.
+
+## Contributing as a developer
+
+Built using [Laravel](https://laravel.com).
+
+We use these extra dependencies to develop Cachet:
+
+- Node.js
+- Gulp
+- Git
+
+Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action.