README.md in rsyntaxtree-1.0.6 vs README.md in rsyntaxtree-1.0.7

- old
+ new

@@ -1,25 +1,77 @@ -# 🌲 RSyntaxTree +<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/rsyntaxtree.png?raw=true' style='width: 256px;' /> -**RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language inspired by [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/). +**RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language. +--- + +### Documentation + +Documentation is currently available in the following languages: + +- [English](https://yohasebe.github.io/rsyntaxtree/documentation) +- [日本語](https://yohasebe.github.io/rsyntaxtree/documentation_ja) + +--- + ### Web Interface +<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/rsyntaxtree-web-screenshot.png?raw=true' width='700px'/> + See updates and a working web interface available at <https://yohasebe.com/rsyntaxtree>. +You can run RSyntaxTree's web interface on your local machine using Docker Desktop. See [RSyntaxTree Web UI](https://github.com/yohasebe/rsyntaxtree_web) + +--- + +### Examples + +See [RSyntaxTree Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples) page for syntax tree samples for + +- Generative Grammar +- Combinatory Categorial Grammar (Experimental) +- Head-Driven Phrase Structure Grammar (Experimental) +- Cognitive Grammar (Experimental) + + +**Input text** + +```text +[S + [NP |R|<>SyntaxTree] + [VP + [V generates] + [NP + [Adj #\+multilingual\ + \+beautiful] + [NP syntax\ + trees] + ] + ] +] +``` + +**Output (PNG or SVG)** + +<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' /> + +--- + ### Installation `# gem install rsyntaxtree` +--- + ### Usage 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: ```text -SyntaxTree, (linguistic) syntax tree generator written in Ruby. +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: ./) @@ -36,43 +88,24 @@ -p, --polyline=<s> draw polyline connectors: on or off (default: off) -e, --version Print version and exit -h, --help Show this message``` ``` -See [the documentation](https://yohasebe.com/rsyntaxtree/#documentation) for more detailed info about the syntax. +See the [documentation](https://yohasebe.github.io/rsyntaxtree/documentation) for more detailed info about the syntax. -### Example +--- -**Input text** - -```text -[S - [NP |R|<>SyntaxTree] - [VP - [V generates] - [NP - [Adj #\+multilingual\ - \+beautiful] - [NP syntax\ - trees] - ] - ] -] -``` - -**Output (PNG or SVG)** - -<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' /> - -See [RSyntaxTree Examples](https://yohasebe.notion.site/yohasebe/RSyntaxTree-Examples-006baf3ac6e84e7193b538a5bf02ad07) for more examples - ### Development For the latest updates and downloads please visit <http://github.com/yohasebe/rsyntaxtree> +--- + ### Author Yoichiro Hasebe <yohasebe@gmail.com> + +--- ### License RSyntaxTree is distributed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).