Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Aquire achievements while using git.
branch: gh-pages

This branch is 52 commits ahead, 5 commits behind icefox:gh-pages

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
test
.gitattributes
.gitignore
README
git-achievements
index.html
index.rss
style.css

README

Git-Achievements records all of the achievements you acquire while using Git.

There are over 40 achievement, most with different levels to be achieved.
After a git command is executed if a new achievement is unlocked
git-achievements will display a message on the console for your enjoyment:

********************************************************************************
                            Git Achievement Unlocked!                            

                                    Caretaker                                    
                    Added a .gitignore file to a repository.                    
********************************************************************************


GitHub Pages
------------

A log of all of your achievements is kept locally, but you can also publish
it to GitHub pages so you can share your achievements (and there is a rss
feed so people can track your achievements).

For example here is the project maintainer's achievements page: http://icefox.github.com/git-achievements

If you are viewing a forked version of git-achievements you want to replace icefox
with the github user account you want to see like so:

http://<username>.github.com/git-achievements

To push your achievements to GitHub first fork the project on GitHub,
clone *your* repository and set the following config to true:

git config --global achievement.upload "true"

When an achievement is unlocked the index.html file will be overwritten,
committed and then a 'git push origin' will be executed.


Install
-------
Add git-achievements to your path and alias git to git-achievements

For example add the following to the end of your ~/.bash_profile

export PATH="$PATH:~/git/git-achievements"
alias git="git-achievements"

You can get your first achievement by running

    git achievements --help

Running Tests
-----
Install Urchin (http://www.urchin.sh) by putting it in your PATH;
here's one way to do that.

    wget -O /usr/local/bin/urchin https://raw.github.com/scraperwiki/urchin/0c6837cfbdd0963903bf0463b05160c2aecc22ef/urchin
    chmod +x /usr/local/bin/urchin

Run the tests like so (from the root of the git repository.)

    urchin ./test
Something went wrong with that request. Please try again.