2019-09-16 10:50:51 +00:00
|
|
|
![espanso](images/titlebar.png)
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-09-16 12:42:51 +00:00
|
|
|
> A cross-platform Text Expander written in Rust
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-10-19 19:55:08 +00:00
|
|
|
![GitHub release (latest by date)](https://img.shields.io/github/v/release/federico-terzi/espanso)
|
2019-09-16 12:25:09 +00:00
|
|
|
![Language](https://img.shields.io/badge/language-rust-orange)
|
|
|
|
![Platforms](https://img.shields.io/badge/platforms-Windows%2C%20macOS%20and%20Linux-blue)
|
|
|
|
![License](https://img.shields.io/github/license/federico-terzi/espanso)
|
2019-09-21 16:21:26 +00:00
|
|
|
[![Build Status](https://dev.azure.com/freddy6896/espanso/_apis/build/status/federico-terzi.espanso?branchName=master)](https://dev.azure.com/freddy6896/espanso/_build/latest?definitionId=1&branchName=master)
|
2019-09-16 12:25:09 +00:00
|
|
|
|
2019-09-16 10:50:51 +00:00
|
|
|
![example](images/example.gif)
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-09-28 08:21:01 +00:00
|
|
|
Visit the [espanso website](https://espanso.org).
|
|
|
|
|
2019-09-16 12:42:51 +00:00
|
|
|
#### What is a Text Expander?
|
2019-09-15 17:35:05 +00:00
|
|
|
|
2019-09-15 18:25:33 +00:00
|
|
|
A *text expander* is a program that detects when you type
|
2019-09-15 17:35:05 +00:00
|
|
|
a specific **keyword** and replaces it with **something else**.
|
|
|
|
This is useful in many ways:
|
2019-09-15 18:25:33 +00:00
|
|
|
* **Save a lot of typing**, expanding common sentences.
|
|
|
|
* Create **system-wide** code snippets.
|
|
|
|
* Execute **custom scripts**
|
|
|
|
* Use **emojis** like a pro.
|
2019-09-15 17:35:05 +00:00
|
|
|
|
2019-09-16 12:42:51 +00:00
|
|
|
___
|
|
|
|
|
|
|
|
## Key Features
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-09-15 17:35:05 +00:00
|
|
|
* Works on **Windows**, **macOS** and **Linux**
|
2019-09-15 18:25:33 +00:00
|
|
|
* Works with almost **any program**
|
2019-09-15 17:35:05 +00:00
|
|
|
* Works with **Emojis** 😄
|
|
|
|
* **Date** expansion support
|
|
|
|
* **Custom scripts** support
|
|
|
|
* **Shell commands** support
|
|
|
|
* **App-specific** configurations
|
2019-09-28 08:21:01 +00:00
|
|
|
* Expandable with **packages**
|
|
|
|
* Built-in **package manager** for [espanso hub](https://hub.espanso.org/)
|
2019-09-15 17:10:18 +00:00
|
|
|
* File based configuration
|
|
|
|
|
2019-09-28 08:21:01 +00:00
|
|
|
## Get Started
|
2019-09-18 09:43:52 +00:00
|
|
|
|
2019-09-28 08:21:01 +00:00
|
|
|
Visit the [official documentation](https://espanso.org/docs/).
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-09-16 12:25:09 +00:00
|
|
|
## Donations
|
2019-09-16 10:50:51 +00:00
|
|
|
|
|
|
|
espanso is a free, open source software developed in my (little) spare time.
|
|
|
|
If you liked the project and would like to support further development,
|
|
|
|
please consider making a small donation, it really helps :)
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-09-16 10:50:51 +00:00
|
|
|
[![Donate with PayPal](images/donate.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FHNLR5DRS267E&source=url)
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-10-12 08:34:31 +00:00
|
|
|
## Contributors
|
|
|
|
|
|
|
|
Many people helped the project along the way, thanks to all of you. In particular, I want to thank:
|
|
|
|
|
|
|
|
* [Scrumplex](https://scrumplex.net/) - Official AUR repo mantainer and Linux Guru
|
|
|
|
* [Luca Antognetti](https://github.com/luca-ant) - Linux and Windows Tester
|
|
|
|
* [Matteo Pellegrino](https://www.matteopellegrino.me/) - MacOS Tester
|
|
|
|
|
2019-09-28 08:21:01 +00:00
|
|
|
## Remarks
|
|
|
|
|
|
|
|
* Special thanks to the [ModifyPath](https://www.legroom.net/software/modpath)
|
|
|
|
script, used by espanso to improve the Windows installer.
|
|
|
|
|
2019-09-16 12:25:09 +00:00
|
|
|
## License
|
2019-09-15 17:10:18 +00:00
|
|
|
|
2019-09-15 17:35:05 +00:00
|
|
|
espanso was created by [Federico Terzi](http://federicoterzi.com)
|
|
|
|
and is licensed under the [GPL-3.0 license](/LICENSE).
|