README.md in rsyntaxtree-0.6.92 vs README.md in rsyntaxtree-0.7.0
- old
+ new
@@ -1,44 +1,45 @@
# RSyntaxTree: yet another syntax tree generator in Ruby
-RSyntaxTree is a graphical syntax tree generator written in the Ruby programming language. It is basically a port of [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/) created by André Eisenbach.
+**RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language inspired by [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/).
-While phpSyntaxTree does not accept **multi-byte characters** as those in Chinese, Japanese, and Korean, RSyntaxTree handles text of any language as long as encoded in UTF-8 and fonts have been installed. Additionally, RSyntaxTree can output **symmetrized** tree diagrams, a functionality that is not implemented in phpSyntaxTree.
+- - -
-RSyntaxTree consists of an easy-to-use command-line app and a web-based interface made with [Sinatra](http://www.sinatrarb.com) web framework.
-
### Web Interface
-Working web interface of a previous version of RSyntaxTree is available at http://yohasebe.com/rsyntaxtree . New version will be deployed soon.
+Working web interface of is available at <https://yohasebe.com/rsyntaxtree>.
### Installation
`# gem install rsyntaxtree`
### Usage
-For the web interface, see Usage section in http://yohasebe.com/rsyntaxtree .
+For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
For the command-line interface, type `$rsyntaxtree -h` after installation. Here's what you get:
- RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
-
- Usage:
- rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
- where [options] are:
- --outdir, -o <s>: Output directory (default: present working directory) (default: ./)
- --format, -f <s>: Output format: png, pdf, or svg (default: png)
- --leafstyle, -l <s>: visual style of tree leaves: auto, triangle, bar, or nothing (default: auto)
- --fontstyle, -n <s>: Font style: sans-serif, serif, jp-gothic, jp-mincho, cjk (default: cjk)
- --font, -t <s>: Path to a ttf font used to generate tree
- --fontsize, -s <i>: Font size: 8-20 (default: 16)
- --color, -c <s>: Color text and bars: on or off (default: on)
- --symmetrize, -y <s>: Generate symmetrical, balanced tree: on or off (default: on)
- --autosub, -a <s>: Put subscript numbers to nodes: on or off (default: off)
- --version, -v: Print version and exit
- --help, -h: Show this message
+```text
+RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
+Usage:
+ rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
+where [options] are:
+ -o, --outdir=<s> Output directory (default: ./)
+ -f, --format=<s> Output format: png, pdf, or svg (default: png)
+ -l, --leafstyle=<s> visual style of tree leaves: auto, triangle, bar, or nothing (default: auto)
+ -n, --fontstyle=<s> Font style (available when ttf font is specified): sans, serif, mono, cjk (default: sans)
+ -t, --font=<s> Path to a ttf font used to generate tree (optional)
+ -s, --fontsize=<i> Size: 8-26 (default: 16)
+ -m, --margin=<i> Margin: 0-120 (default: 0)
+ -c, --color=<s> Color text and bars: on or off (default: on)
+ -y, --symmetrize=<s> Generate symmetrical, balanced tree: on or off (default: on)
+ -a, --autosub=<s> Put subscript numbers to nodes: on or off (default: off)
+ -v, --version Print version and exit
+ -h, --help Show this message
+```
+
### Tips
Every branch or leaf of a tree must belong to a node. To create a node, place a label right next to the opening bracket. Arbitrary number of branches can follow with a preceding space.
There are several modes in which the connectors between terminal nodes and their leaves are drawn differently (auto, triangle, bar, and nothing). In auto mode, a triangle is used if the leaf contains one or more spaces inside (i.e. if it’s a phrase), but if it contains no spaces (i.e. if it is just a word), a straight bar will be drawn instead (unless the leaf contains a "^" symbol at the end which makes it a single-word phrase).
@@ -47,22 +48,24 @@
### Example
Bracket notation (auto-subscript-on):
- [S [NP RSyntaxTree^][VP [V generates][NP multilingual syntax trees]]]
+```text
+[S [NP RSyntaxTree^][VP [V generates][NP multilingual syntax trees]]]
+```
Resulting PNG
-
+
### Development
For the latest updates and downloads please visit http://github.com/yohasebe/rsyntaxtree
### Author
-Yoichiro Hasebe yohasebe@gmail.com
+Yoichiro Hasebe <yohasebe@gmail.com>
### License
RSyntaxTree is distributed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).