X-Git-Url: https://projects.mako.cc/source/selectricity-live/blobdiff_plain/2fed9b6ceaf0953daf0f085f78520263ab0fa804..9a15981ecd4893c6ca1e6c0e89da0b497824d1f9:/README?ds=inline diff --git a/README b/README index ea3df41..afa0a25 100644 --- a/README +++ b/README @@ -1,5 +1,37 @@ =============================================== -=== Depedendencies ============================ +=== Getting Selectricity ====================== +=============================================== + +Selectricity is free software and is distributed under the GNU Affero +General Public License version 3. You are free to use, modify, and +distribute, or rework Selectricity under the terms of that license. Of +course, we'd sure like it if you would send fixes back to us and tell us +about cool stuff you do with our software! + +The best way to get Selectricity is just to download it from our source +source repository. You'll need the Git version control system or +source control manager to check it. You can get it here: + + http://git-scm.com/ + +Once you have it, getting the source code is pretty easy. You just need +to check out a branch with a command like this: + + git clone http://projects.mako.cc/source/selectricity/.git + +By default, this will create a working copy with the latest +*development* version of our code. If you want the latest production +version (i.e., what we're running on the site), you need to switch to +the live version of the software which is kept in a branch called +"live." Once you cloned the repository above, you can switch into the +directory (i.e., run "cd selectricity") and then run the following +command: + + git checkout -b live origin/live + + +=============================================== +=== Dependencies ============================== =============================================== To use Selectricity, you'll need to install the following gems in