Getting Started

Follow these steps to start working on IGN++

If you're unfamiliar with github, read this explanation of what's going on with github. Note that this is intended more for people forking the project, working on it, and then submitting a pull request. Collaborators don't have to worry about that and instead commit directly to this repo. Regardless, it provides a number of helpful commands and explanations.

Follow the directions for getting git running with the repo: Getting started with Git and GitHub. Note that I use the msysgit GUI on Windows, though I still have the option of using the bash interface. If you're a collaborator, you'll want to clone this repo to some directory on your computer and push your changes to git@github.com:fracture91/ignpp.git. You will also point Firefox and Chrome to this directory so you can test your code. If you're not a collaborator, you can fork the repo and, when done with your changes, submit a pull request so I can merge your changes into my repo.

If you're new to Firefox extensions, read up on them: Firefox extensions page

Point Firefox to your local repo for testing. I also suggest using a clean Firefox profile with only essential developers' extensions installed:

If you're new to Chrome extensions, read up on them: Chrome extensions page

Point Chrome to your local repo for testing, see step 4

MDN is incredibly helpful with general JavaScript, DOM, CSS, HTML, and XUL pages.

You should end up with one directory that holds the extension files. Chrome and Firefox are pointed to this folder so you can easily test your latest changes. Git stores your local repo in this folder as well.

Next you should change the dev ID in cssid.cfg to match the ID of your unpacked extension installation. Then, with your working directory set to your repo directory, run:

$ ./cssid.sh dev
$ ./console.sh enable

This will allow you to see images on Chrome and use the dev console. These scripts change main.css and console.js. Please don't commit these changes.

When you make a change to a content script, you can see that change in Firefox by simply refreshing the boards page you're on. If you make a change to a "background" file like script-compiler.js, you'll need to restart the browser. Sometimes with changes to options.xul I need to disable the extension and then immediately enable it, then restart.

In Chrome I think you have to reload the extension on the extension page, then refresh the boards page you're on for any change you make.