| 1 |
|
= What is Edmaru? |
| 2 |
|
|
| 3 |
= For users |
Edmaru is a scalable text editor implemented by Ruby. This program is |
| 4 |
|
free software; you can redistribute it and/or modify it under the |
| 5 |
== Debian GNU/Linux Users |
terms of the GNU General Public License version 2 as published by the |
| 6 |
|
Free Software Foundation. |
| 7 |
=== Requirement |
|
| 8 |
|
= For more detail |
| 9 |
The following packages are required if you are using Debian unstable. |
|
| 10 |
The required minimum version number shown below is not sure but I |
If you want to know about Edmaru in more detail, see the following |
| 11 |
recommend them to make it sure that Edmaru runs correctly. |
documents: |
| 12 |
|
|
| 13 |
- ruby [>= 1.8] |
AUTHORS :: The list of Edmaru's developers and contributors. |
| 14 |
- libncurses-ruby [>= 1.1-1] (for console) |
COPYING :: The license terms of Edmaru. (GNU General Public License) |
| 15 |
- libgtk2-ruby [>= 0.15.0-1.1] (for GUI by Gtk+2) |
ChangeLog :: The trail of Edmaru's development. |
| 16 |
|
README :: This file describing the basic information about Edmaru. |
| 17 |
=== How to launch |
doc/DEVELOPMENT :: The documents for Edmaru's developers. |
| 18 |
|
doc/INSTALL :: Installation documents. |
| 19 |
Go to the root directory of Edmaru source tree and run edmaru.rb (Ruby |
doc/USAGE :: The basic usage of Edmaru. |
|
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" |
|
Parent Directory
Revision Log
Patch