ShadowFox/README.md

![header](.github/Screenshots/header.png)

ShadowFox was inspired by changes made in Firefox 57, which limited the amount addons could customize both the user interface and "protected" web pages.

This project aims at creating a universal dark theme for Firefox while adhering to the modern design principles set by Mozilla.

## Preview

![preferences](.github/Screenshots/preview.png)

ShadowFox styles the entire user interface, protected webpages (such as `about:` pages and addons.mozilla.org), and over 20 popular addons.

## Installation

* Download the updater script from the [releases](https://github.com/overdodactyl/ShadowFox/releases) page for your operating system.

* Place this script in your Firefox profile directory.

  * Visit `about:support` by entering this address in the url bar.

  * Scroll down to `Application Basics`.

  * In the `Profile Folder` section, click the button that says "Open Folder", "Show in Finder" or "Open Directory" (OS dependent).

    * On Windows and Linux, this should take you directly to your profile directory. On a Mac, this will take you to a list of Firefox profiles, with the one you want highlighted. In this case, double click that folder to open it.

* Run the script.

* Restart Firefox.

***IMPORTANT***: Changes to webextensions do not go into effect by default. For more information, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Altering-webextensions).

## Updating

* Run the updater script.

## Customization

It's easy to customize ShadowFox, everything from the colors used to what elements and webpages are styled.  Depending on how much you want to customize ShadowFox, you may be better suited using a different installation process.  To learn more, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Getting-Started).


# Find a bug? Have a feature request? Have any questions?

Please first read through the [wiki](https://github.com/overdodactyl/ShadowFox/wiki/) (including the getting started information, troubleshooting, and known problems) and take a look at any open [issues](https://github.com/overdodactyl/ShadowFox/issues).  If you can't find a duplicate request, bug, or an answer to your question, please feel free to either:

* Open a [new issue](https://github.com/overdodactyl/ShadowFox/issues/new)

* Make a post on the ShadowFox [Reddit page](https://www.reddit.com/r/ShadowFoxCSS/).


# Contributing

I welcome any contributions and would be excited to have a team of people helping with this project.  If you are uncomfortable making pull requests, you can simply open up an issue and attach any code you would like included.
restructure repo 2018-03-11 21:58:02 +00:00			`![header](.github/Screenshots/header.png)`
Update README.md 2017-12-18 23:06:06 +00:00
Update README.md 2018-02-27 21:16:38 +00:00			`ShadowFox was inspired by changes made in Firefox 57, which limited the amount addons could customize both the user interface and "protected" web pages.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`This project aims at creating a universal dark theme for Firefox while adhering to the modern design principles set by Mozilla.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`## Preview`
Update README.md 2017-12-18 23:06:06 +00:00
restructure repo 2018-03-11 21:58:02 +00:00			`![preferences](.github/Screenshots/preview.png)`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			ShadowFox styles the entire user interface, protected webpages (such as `about:` pages and addons.mozilla.org), and over 20 popular addons.
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`## Installation`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Download the updater script from the [releases](https://github.com/overdodactyl/ShadowFox/releases) page for your operating system.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Place this script in your Firefox profile directory.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			* Visit `about:support` by entering this address in the url bar.
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			* Scroll down to `Application Basics`.
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			* In the `Profile Folder` section, click the button that says "Open Folder", "Show in Finder" or "Open Directory" (OS dependent).
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* On Windows and Linux, this should take you directly to your profile directory. On a Mac, this will take you to a list of Firefox profiles, with the one you want highlighted. In this case, double click that folder to open it.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Run the script.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Restart Firefox.`
Update README and userContent_imports 2018-01-05 22:00:36 +00:00
Update README 2018-02-26 23:34:16 +00:00			`*IMPORTANT*: Changes to webextensions do not go into effect by default. For more information, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Altering-webextensions).`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`## Updating`
Update README.md 2017-12-08 05:25:44 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Run the updater script.`
Update README.md 2017-12-08 05:25:44 +00:00
Update README 2018-02-26 23:34:16 +00:00			`## Customization`
Update README.md 2017-12-02 04:55:47 +00:00
Update README 2018-02-26 23:34:16 +00:00			`It's easy to customize ShadowFox, everything from the colors used to what elements and webpages are styled. Depending on how much you want to customize ShadowFox, you may be better suited using a different installation process. To learn more, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Getting-Started).`
Update README.md 2017-12-02 04:55:47 +00:00
Addon AMO screenshot to README.md 2017-12-08 08:21:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`# Find a bug? Have a feature request? Have any questions?`
Update README.md 2017-12-22 19:24:02 +00:00
Update README 2018-02-26 23:34:16 +00:00			`Please first read through the [wiki](https://github.com/overdodactyl/ShadowFox/wiki/) (including the getting started information, troubleshooting, and known problems) and take a look at any open [issues](https://github.com/overdodactyl/ShadowFox/issues). If you can't find a duplicate request, bug, or an answer to your question, please feel free to either:`
Update README.md 2017-12-22 19:24:02 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Open a [new issue](https://github.com/overdodactyl/ShadowFox/issues/new)`
Add compatibility for webextension chages 2017-11-30 02:26:03 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Make a post on the ShadowFox [Reddit page](https://www.reddit.com/r/ShadowFoxCSS/).`
Add compatibility for webextension chages 2017-11-30 02:26:03 +00:00
Variable replacement 1 2018-02-22 05:20:30 +00:00
Update README.md 2017-12-18 23:32:42 +00:00			`# Contributing`
Add compatibility for webextension chages 2017-11-30 02:26:03 +00:00
Update README.md 2017-12-18 23:32:42 +00:00			`I welcome any contributions and would be excited to have a team of people helping with this project. If you are uncomfortable making pull requests, you can simply open up an issue and attach any code you would like included.`