Skip to content

Commit

Permalink
Add ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
sanssecours committed Oct 26, 2015
1 parent d9296d4 commit bd2bbfa
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Special Characters Bundle

This repository contains a [TextMate][] bundle that helps you to easily insert special characters into your document. The video below shows how to insert special characters via the command “Convert Single Character”:

<center>
<img src="Support/Help/Images/Convert Single Character.gif" alt="Insert various special characters via “Convert Single Character”" style="width: 200px;"/>
</center>

For more information about the bundle's functionality please take a look at the [documentation](Support/Help/Help.md).

[TextMate]: http://github.com/textmate/textmate

# Installation

## Manual

1. Download the latest [release][].
2. Unzip the archive
3. Double click on “Special Characters.tmbundle”

[release]: http://github.com/sanssecours/Special-Characters.tmbundle/releases

## Terminal

```bash
mkdir -p "$HOME/Library/Application Support/Avian/Bundles"
cd "$HOME/Library/Application Support/Avian/Bundles"
git clone https://github.com/sanssecours/Special-Characters.tmbundle
```

# Requirements

**Operating System:** OS X 10.10.0 or newer
**TextMate:** v2.0-beta.1 or newer

# License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

# Pricing

If you use this bundle frequently, please [donate][] €2 (or more). Thank you!

[gratis]: https://en.wikipedia.org/wiki/Gratis_versus_libre
[donate]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=sanssecours%40f%2dm%2efm&lc=AT&item_name=Donate%20to%20the%20author%20of%20the%20%22Special%20Characters%20Bundle%22&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted

0 comments on commit bd2bbfa

Please sign in to comment.