2021-10-05 19:08:05 +00:00
|
|
|
|
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
|
|
|
|
2019-09-16 12:25:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-16 10:50:51 +00:00
|
|
|
|
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** 😄
|
2019-12-13 23:01:04 +00:00
|
|
|
* Works with **Images**
|
2021-10-05 19:08:05 +00:00
|
|
|
* Includes a powerful **Search Bar** 🔎
|
2019-09-15 17:35:05 +00:00
|
|
|
* **Date** expansion support
|
|
|
|
|
* **Custom scripts** support
|
|
|
|
|
* **Shell commands** support
|
|
|
|
|
* **App-specific** configurations
|
2020-12-03 18:37:22 +00:00
|
|
|
* Support [Forms](https://espanso.org/docs/forms/)
|
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
|
2021-10-05 19:08:05 +00:00
|
|
|
* Support Regex triggers
|
|
|
|
|
* Experimental Wayland support
|
2019-09-15 17:10:18 +00:00
|
|
|
|
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-11-30 17:47:22 +00:00
|
|
|
## Support
|
|
|
|
|
|
|
|
|
|
If you need some help to setup espanso, want to ask a question or simply get involved
|
|
|
|
|
in the community, [Join the official Subreddit](https://www.reddit.com/r/espanso/)! :)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
2020-01-21 22:20:54 +00:00
|
|
|
[](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
|
|
|
|
|
|
2021-10-05 19:08:05 +00:00
|
|
|
Many people helped the project along the way, thank you to all of you!
|
2019-10-12 08:34:31 +00:00
|
|
|
|
2021-10-05 19:08:05 +00:00
|
|
|
<a href="https://github.com/federico-terzi/espanso/graphs/contributors">
|
|
|
|
|
<img src="https://contrib.rocks/image?repo=federico-terzi/espanso" />
|
|
|
|
|
</a>
|
2019-10-12 08:34:31 +00:00
|
|
|
|
2019-09-28 08:21:01 +00:00
|
|
|
## Remarks
|
|
|
|
|
|
2020-06-29 18:52:03 +00:00
|
|
|
* Thanks to [libxdo](https://github.com/jordansissel/xdotool) and [xclip](https://github.com/astrand/xclip), used to implement the Linux port.
|
2021-10-05 19:08:05 +00:00
|
|
|
* Thanks to [libxkbcommon](https://xkbcommon.org/) and [wl-clipboard](https://github.com/bugaevc/wl-clipboard), used to implement the Wayland port.
|
|
|
|
|
* Thanks to [wxWidgets](https://www.wxwidgets.org/) for providing a powerful cross-platform GUI library.
|
2019-09-28 08:21:01 +00:00
|
|
|
|
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)
|
2020-06-29 18:52:03 +00:00
|
|
|
and is licensed under the [GPL-3.0 license](/LICENSE).
|
