Develop and Download Open Source Software


= For users

== Debian GNU/Linux Users

=== Requirement

The following packages are required if you are using Debian unstable.
The required minimum version number shown below is not sure but I
recommend them to make it sure that Edmaru runs correctly.

 - ruby [>= 1.8]
 - libncurses-ruby [>= 1.1-1] (for console)
 - libgtk2-ruby [>= 0.15.0-1.1] (for GUI by Gtk+2)

=== How to launch

Go to the root directory of Edmaru source tree and run edmaru.rb (Ruby
script) like:

 $ cd edmaru
 $ ./edmaru.rb

The above example launch Edmaru with the character based UI. If you
want to use it with Gtk+2 based UI, specify "gtk" as the first
argument of edmaru.rb like:

 $ ./edmaru.rb gtk

== How to launch

= For developers

== Development documentation

If you want to improve Edmaru, it is a nice idea to see class
specification. Edmaru source codes are designed to generate "rdoc"
documentations, therefore, first you should run the following command
at the root directory of Edmaru source tree:

 $ rdoc

Then, you can find class specification documents in "doc" directory
and open "doc/index.html" by your favorite Web browser to see them.

== About character encodings

All source files in Edmaru source tree must be encoded by UTF-8.

== How to run all unit test suites

Edmaru uses Test::Unit so just run the test codes like:

 $ ruby test.rb

== How to write a new test suite

1. Create a new test suite codes by Test::Unit.
2. Save the source codes as "test/test_*.rb"
3. Append a new line to "test.rb" like 
 require "test/test_*.rb"