How to use ShadowFox - revisiting installation and updating

[overdodactyl]

As this project continues to grow, I think having an easy and clear method to (1) install and (2) update the project is increasingly important.

I can imagine this project being used in a number of different ways by different users, and my goal would be to accommodate the various approaches.

Some people may wish to use the entire repo, others only certain files, some may wish to change the default colors, in the case of webextension tweaks, the Internal UUID needs to be changed etc.

To complicate things, several Linux users reported a Firefox bug that prevents the proper usage of @import statements.

As such, there are currently two versions of userChrome/Content in the repo (one that is all inclusive, and one that contains import statements). Additionally, I recently included a "release" containing the two files.

Here's my initial thoughts on how people could approach installation:

and to accompany the various approaches, I would include updater scripts that would do the following:

I'm curious how everyone is using this repo, and whether the approach/guide given above makes sense to everyone.

If you have any thoughts or suggestions, please leave them below!

Additionally, I may need some help righting the Windows equivalent of such a script (perhaps @CaptaPraelium would be interested? ;) )

[janhieber]

Sorry but this does not really help for installing this. I am an experienced Linux user and it is not clear if I should download the two user...css files and why there are so many node modules etc...

Maybe an "Install" section in the README would be great.

Example:
Goto about:profiles and look for "root directory". Open a console at this path.
Then clone the repo.

cd ~/.mozilla/firefox/567prclp.default #replace with your path
mv chrome chrome_bak
git clone https://github.com/overdodactyl/ShadowFox.git chrome

To update this, use git pull in that folder.

[overdodactyl]

Hi @janhieber, thanks for the comment! I'm currently working on a little write-up for installation and updating. I'll let you know when it's complete.

This was more to hopefully get an idea on what type of functions an updater script should have, or if even anyone would benefit from that.

The node modules are needed to run gulp, which concatenates a defined set of .css files. See here for more info on that.

[overdodactyl]

@janhieber, I've added a new wiki page that hopefully will help straighten things out:

https://github.com/overdodactyl/ShadowFox/wiki

it's still a work in progress, but hopefully a good start :)

[CaptaPraelium]

Sorry, only just saw this. Definitely will write anything you need, I owe you some time, you did save my retina after all ;)