ShadowFox/README.md

51 lines
2.7 KiB
Markdown
Raw Normal View History

2018-03-11 21:58:02 +00:00
![header](.github/Screenshots/header.png)
2017-12-18 23:06:06 +00:00
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.
2017-12-18 23:06:06 +00:00
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.
2017-12-18 23:06:06 +00:00
2018-02-26 23:34:16 +00:00
## Preview
2017-12-18 23:06:06 +00:00
2018-03-11 21:58:02 +00:00
![preferences](.github/Screenshots/preview.png)
2017-12-18 23:06:06 +00:00
2018-04-22 05:10:19 +00:00
ShadowFox styles the entire user interface, protected webpages (such as `about:` pages and addons.mozilla.org), and over 40 popular addons.
2017-12-18 23:06:06 +00:00
2018-02-26 23:34:16 +00:00
## Installation
2017-12-18 23:06:06 +00:00
2018-04-22 01:34:45 +00:00
1. Download the updater script from the [releases](https://github.com/SrKomodo/shadowfox-updater/releases) page of [shadowfox-updater](https://github.com/SrKomodo/shadowfox-updater) for your operating system and place it in a location you will remember for future use.
2017-12-18 23:06:06 +00:00
2018-04-25 17:08:33 +00:00
* On Arch Linux, you can install the package [shadowfox-updater](https://aur.archlinux.org/packages/shadowfox-updater/) from AUR.
2018-04-25 15:36:40 +00:00
2018-04-22 01:34:45 +00:00
2. Run the script.
2017-12-18 23:06:06 +00:00
2018-04-22 01:34:45 +00:00
3. Restart Firefox.
2017-12-18 23:06:06 +00:00
For more detailed instructions, please see [here](https://github.com/overdodactyl/ShadowFox/wiki/Installation).
2017-12-18 23:06:06 +00:00
2018-02-26 23:34:16 +00:00
## Updating
2017-12-08 05:25:44 +00:00
2018-04-22 01:34:45 +00:00
Any time you want to update ShadowFox or apply custom changes, simply run the updater script again.
2017-12-08 05:25:44 +00:00
2018-02-26 23:34:16 +00:00
## Customization
2017-12-02 04:55:47 +00:00
2018-04-22 01:34:45 +00:00
It's easy to customize ShadowFox, everything from the colors used to what elements and webpages are styled. For more information, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Customization).
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/Development).
2017-12-02 04:55:47 +00:00
2018-03-13 02:31:13 +00:00
## Discussion
2017-12-08 08:21:06 +00:00
2018-03-13 02:31:51 +00:00
* Chat about ShadowFox on Slack - [invitation link](https://join.slack.com/t/shadowfox-workspace/shared_invite/enQtMzI5Nzk5OTk1MjcxLThkMDgwOGE5ZDY1MDUyNjIwNWQ2MTlmMjEwZTJiZmZjYTUxODM4ZTRkNzhiNGRhZTFhMjdjMTFjMTQ3YjZjYzU)
2018-03-13 02:31:13 +00:00
## Find a bug? Have a feature request? Have any questions?
2017-12-22 19:24:02 +00:00
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:
2017-12-22 19:24:02 +00:00
2018-02-26 23:34:16 +00:00
* Open a [new issue](https://github.com/overdodactyl/ShadowFox/issues/new)
2018-02-26 23:34:16 +00:00
* Make a post on the ShadowFox [Reddit page](https://www.reddit.com/r/ShadowFoxCSS/).
2018-02-22 05:20:30 +00:00
2018-03-13 02:31:13 +00:00
## Contributing
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.