Browse Subversion Repository
Annotation of /README
 Parent Directory
|  Revision Log
Revision 1 -
( hide annotations)
( download)
Tue Apr 3 11:13:38 2007 UTC
(16 years, 11 months ago)
by bluedwarf
File size: 839 byte(s)
Initial import.
| 1 |
bluedwarf |
1 |
|
| 2 |
|
|
= For developers |
| 3 |
|
|
|
| 4 |
|
|
== Development documentation |
| 5 |
|
|
|
| 6 |
|
|
If you want to improve Edmaru, it is a nice idea to see class |
| 7 |
|
|
specification. Edmaru source codes are designed to generate "rdoc" |
| 8 |
|
|
documentations, therefore, first you should run the following command |
| 9 |
|
|
at the root directory of Edmaru source tree: |
| 10 |
|
|
|
| 11 |
|
|
$ rdoc |
| 12 |
|
|
|
| 13 |
|
|
Then, you can find class specification documents in "doc" directory |
| 14 |
|
|
and open "doc/index.html" by your favorite Web browser to see them. |
| 15 |
|
|
|
| 16 |
|
|
== About character encodings |
| 17 |
|
|
|
| 18 |
|
|
All source files in Edmaru source tree must be encoded by UTF-8. |
| 19 |
|
|
|
| 20 |
|
|
== How to run all unit test suites |
| 21 |
|
|
|
| 22 |
|
|
Edmaru uses Test::Unit so just run the test codes like: |
| 23 |
|
|
|
| 24 |
|
|
$ ruby test.rb |
| 25 |
|
|
|
| 26 |
|
|
== How to write a new test suite |
| 27 |
|
|
|
| 28 |
|
|
1. Create a new test suite codes by Test::Unit. |
| 29 |
|
|
2. Save the source codes as "test/test_*.rb" |
| 30 |
|
|
3. Append a new line to "test.rb" like |
| 31 |
|
|
require "test/test_*.rb" |
| 
Parent Directory
Revision Log