https://github.com/sobjornstad/tersen
the fast, flexible abbreviation engine
https://github.com/sobjornstad/tersen
abbreviations luarocks shorthand
Last synced: 9 months ago
JSON representation
the fast, flexible abbreviation engine
- Host: GitHub
- URL: https://github.com/sobjornstad/tersen
- Owner: sobjornstad
- License: mit
- Created: 2020-12-13T18:25:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-16T14:53:02.000Z (over 5 years ago)
- Last Synced: 2025-10-10T17:39:25.962Z (9 months ago)
- Topics: abbreviations, luarocks, shorthand
- Language: Lua
- Homepage: https://tersen.readthedocs.io/en/latest/index.html
- Size: 188 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tersen
**Tersen** is a *fast, flexible abbreviation engine*
that compresses text in a human-readable fashion.
Abbreviations are entirely user-specifiable
through a dictionary of textual mappings (e.g., `and` becomes `&`).
More concise dictionary files and custom abbreviation behavior
can be obtained by writing Lua functions called
*annotations* (which pre-process lines in the abbreviation dictionary)
and *hooks* (which alter tersen's behavior as it abbreviates a text).
Use cases for tersen include:
* Packing more information onto a cheat sheet or reference guide.
* Sending content over SMS or another limited-bandwidth communication channel.
* Obfuscating content so others cannot easily read it but you can.
* Practicing your reading skills in your favorite alphabetic shorthand system.
Tersen is written and extended in Lua.
It uses the MIT license.
## Installation
Lua and [LuaRocks](https://luarocks.org) are required to run tersen.
Direct installation via LuaRocks is recommended in most cases:
```
luarocks install tersen
```
For development,
clone this repository and run `make`;
LuaRocks will then install tersen from the sources.
In either case, ``tersen`` will then be installed on your system path.
## Documentation
Complete documentation can be found [on Read the Docs](https://tersen.readthedocs.io/en/latest/index.html)
A [quick-start guide](https://tersen.readthedocs.io/en/latest/qstart.html) is included.