HackersGuide

Hacker’s Guide

This is an introduction to hacking the Alexandria codebase. Alexandria is written in Ruby, an interpreted object-oriented language and uses the Ruby-GTK2 library for the user interface. It’s about ten thousand lines of Ruby code in addition to the user interface description and translations, so you’ll probably want to read this guide first before you start hacking away.

Here are some ideas for sections:
  • RetrievingCode: Get the code on your system to start
  • CodingStyle: All code submitted must follow these guidelines
  • Code base structure – description of the source tree
  • Submitting patches, adding new features guidelines
  • HowToTranslateAlexandria: A guide for would-be translators

Quick Information

  • Svn url: svn://rubyforge.org/var/svn/alexandria/trunk/alexandria

More Guides

These are links to documents that the developers have written on Alexandria. Maybe this information could be incorporated into the Wiki: