librelist archives

« back to archive

directory structure

directory structure

From:
Fela Winkelmolen
Date:
2010-07-12 @ 21:19
Hi here is a draft of the new directory structure I've got in mind

fonts/
installer/
platform/
static/ (rename to images?)
root/
lib/: the library with the code that also the user can use
  sound.rb
  speech.rb
  draw.rb
  turtlescript.rb
  extensions.rb: extensions to string, kernel, fixnum, etc... (now in     
                 kernel.rb numbers.rb object.rb, time.rb)
app/: the application
  syntax/: syntax highlighting
  db/: database stuff
  web/: website integration
  tabs/: 
    home.rb (maybe a dir)
    console.rb (maybe a dir)
    prefs.rb
    editor/
      tab.rb
      foley.rb (from sound.rb)
      artist.rb
      dingbat.rb (now called fonts.rb)
  utils/:
    errors.rb
    h-ety-h.rb content
    widgets.rb
    init.rb
  lessons/
    to be written
unused/:
  unused code like things why started to write but never end up using
  might come in useful some day, so we'll want to keep the files
  like adress.rb 

I didn't look too closely to the database and web integration code but I 
suppose I can just move the code to two directories and then we can see if 
further refactoring is needed..

I also wonder how to best handle the require statements... like what to best 
require from where, any ideas?

- fela

Re: [hacketyhack] directory structure

From:
Steve Klabnik
Date:
2010-07-13 @ 05:10
>
> Hi here is a draft of the new directory structure I've got in mind


Hey fela, this all looks good to me. I think static should be kept as
'static' though.


> I also wonder how to best handle the require statements... like what to
> best
> require from where, any ideas?
>

 I'd keep the same thing as many rubygems (and the current hackety source)
does; a h-ety-h.rb file that mostly just requires almost everything else
that needs to be done, and everything else stems from there.