Skip to content

Commit

Permalink
Better documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
liorgrossman authored Dec 14, 2018
1 parent 82e9275 commit 2708a00
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
# Contriburing to Darkness
Please help us **improve existing skins and create new ones**. Pull requests are welcome!
Please help us **improve the quality of existing skins and create new ones**. Pull requests are welcome!



## Getting started
1. If you haven't yet, [install Darkness locally](./README.md#installation)
1. Open Chrome and use Darkness regularly (e.g. open [Google](https://www.google.com/) and switch to a dark theme)
1. Run `npm start` to watch and auto-compile all SCSS files to CSS in real-time
1. Edit any SCSS or JS file you wish inside the **chrome-extension** directory
1. Refresh the tab (e.g. Google) to see the changes you've made
1. If you haven't yet, [install Darkness Developer Edition](./README.md#installation)
1. Open any supported websites (e.g. [Google](https://www.google.com/)) and switch to a dark theme
1. Run `npm start` to watch and compile all SCSS files to CSS in real-time
1. Edit any SCSS/JS file in the **chrome-extension** directory (e.g. /chrome-extension/themes/websites/google.scss)
1. Refresh the website to see the changes you've made
1. Once finish, [push your changes and send a pull request](#how-to-push-code-back-to-darkness)

Note that development and debugging should be done on Chrome. To test your changes on Firefox, run `gulp ff` and [install Darkness on Firefox](./README.md#installation).
Development and debugging are be done on Chrome. To test your changes on Firefox, run `gulp ff` and [install Darkness on Firefox](./README.md#installation).

## How do I...
#### Fix or improve an existing skin
Edit `/themes/websites/[KEY].scss` (e.g. `/themes/websites/youtube.scss`)


#### Add a skin for an new website (e.g. BBC, Google Drive)
Just run `gulp skin:create --key=[KEY]` where [KEY] is lowercase and alphanumeric (e.g. bbc, googledrive).
#### Add a skin for an new website (e.g. BBC, Yahoo Finance)
Just run `gulp skin:create --key=[KEY]` where [KEY] is lowercase and alphanumeric (e.g. bbc, yahoofinance).

Then follow the instructions:

Expand Down

0 comments on commit 2708a00

Please sign in to comment.