Directory Structure

Hope this helps to more easily navigate through the source code:

• app/ contains the code for the Hackety Hack application
  • db/ database specific code
  • syntax/ syntax highlighting
  • ui/ user interface
    • editor/ the text editor and its helper classes
    • tabs/ sidetabs architecture (sidetabs.rb) and the contents of the various tabs (the editor tab redirects to app/ui/editor)
    • completion.rb autocompletion used by the try ruby console
    • mainwindow.rb the application’s main window
    • widgets.rb additional widgets like glossb (glossy button)
• fonts/ HH provides a number of fonts, including those needed for the dingbats
• installer/ files needed to build the installer
• lessons/ the lessons, written using the lessons DSL
• lib/ enhancements to base classes and a few helper methods, some of which are to be used by the user, others are for internal use in HH
  • art/ helper funcitons to create art (including draw, sound, …). Most of it seem to be working to some degree, but it has to be checked and documented before the user will be able to really use it.
  • dev/ helper functions for internal use in HH
  • enhancements.rb enhancements to existing classes
• platform/ platform specific data for icons, used by the packager
• root/ data that is copied to the computer once HH gets installed
• samples/ sample programs, they are accessible under the samples tab in HH
• spec/ unit tests written using RSpec
• static/ images
• unused/ unused files, including deprecated code we don’t want to throw away, work in progress and proof of concept code
• h-ety-h.rb main executable that will start the application