README.md in rsyntaxtree-1.1.1 vs README.md in rsyntaxtree-1.1.2

- old
+ new

@@ -1,32 +1,27 @@ <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. ---- +## Documentation -### Documentation - Documentation is currently available in the following languages: -- [English](https://yohasebe.github.io/rsyntaxtree/documentation) -- [日本語](https://yohasebe.github.io/rsyntaxtree/documentation_ja) +- [Documentation in English](https://yohasebe.github.io/rsyntaxtree/documentation) +- [日本語ドキュメント](https://yohasebe.github.io/rsyntaxtree/documentation_ja) ---- +- [Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples) +## Web Interface -### 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 -### 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) @@ -52,20 +47,16 @@ **Output (PNG or SVG)** <img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' /> ---- +## Installation -### Installation - `# gem install rsyntaxtree` ---- +## Usage -### 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 @@ -91,23 +82,30 @@ -h, --help Show this message ``` See the [documentation](https://yohasebe.github.io/rsyntaxtree/documentation) for more detailed info about the syntax. ---- +## References -### Development +Please use the following BibTeX entry when referring to RSyntaxTree. -For the latest updates and downloads please visit <http://github.com/yohasebe/rsyntaxtree> +``` +@misc{rsyntaxtree_2023, + author = {Yoichiro Hasebe}, + title = {RSyntaxTree: A graphical syntax tree image generator} + url = {https://yohasebe.com/rsyntaxtree}, + year = {2023} +} +``` ---- +## Development -### Author +For the latest updates and downloads please visit <http://github.com/yohasebe/rsyntaxtree> +## Author + Yoichiro Hasebe <yohasebe@gmail.com> ---- - -### License +## License RSyntaxTree is distributed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).