From f919dec481736a6ed3490ffcd1f47d0126be74eb Mon Sep 17 00:00:00 2001 From: Jesse Kramer Date: Mon, 5 Nov 2018 21:25:08 +0100 Subject: [PATCH] Fix: How to contribute? (#214) * Add README with project description + contribution guidelines. * Updated webserver text in README [skip ci] --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3782c21 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +

+ +
Slack Themes +

+

+ +

+ + +### About the project + +slackthemes.net is a platform for browsing and sharing themes for [Slack](https://slack.com/). +It is not affiliated with [Slack](https://slack.com/) in any way or form; but it is a great tool, use it. + + +### How to contribute (themes) + +1. Fork this project. +2. Add your theme to the `data/themes.yml` file. +3. Create a pull request. + +### How to contribute (core) + +1. Fork this project. +2. Install dependencies using `bundle install` +3. Make changes. +4. Build the project using `bundle exec middleman build` +5. You can [run a local webserver](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server) to test the project. (make sure to use the `./build` folder as your DocumentRoot). +6. Create a pull request. + +### Contributors + +* [Contributors](https://github.com/paracycle/slackthemes/graphs/contributors)