hyphenate/README.md

16 lines
527 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Hyphenate
Lua implementation of KnuthLiang hyphenation algorithm.
## Getting Started
To get started with Hyphenate:
```
$ git clone https://github.com/gsekulski/hyphenate.git
$ cd hyphenate
$ lua hyphenate.lua incomprehensibility
```
## Contributing
Thank for you contributing to Hyphenate! We welcome new contributors of all backgrounds. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## License
This is free and unencumbered software released into the public domain. See [LICENSE](LICENSE) for more details.