Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changed to standard Textmate Readme file
- Loading branch information
Showing
1 changed file
with
13 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,20 @@ | ||
| # C# TextMate Bundle | ||
| # Installation | ||
|
|
||
| This is the C# language TextMate bundle | ||
| You can install this bundle in TextMate by opening the preferences and going to the bundles tab. After installation it will be automatically updated for you. | ||
|
|
||
| ## License | ||
| # General | ||
|
|
||
| This bundle is dual-licensed under MIT and GPL licenses. | ||
| * [Bundle Styleguide](http://kb.textmate.org/bundle_styleguide) — _before you make changes_ | ||
| * [Commit Styleguide](http://kb.textmate.org/commit_styleguide) — _before you send a pull request_ | ||
| * [Writing Bug Reports](http://kb.textmate.org/writing_bug_reports) — _before you report an issue_ | ||
|
|
||
| * [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php) | ||
| * [http://www.gnu.org/licenses/gpl.html](http://www.gnu.org/licenses/gpl.html) | ||
| # License | ||
|
|
||
| Use it, change it, fork it, sell it. Do what you will, but please leave the author attribution. | ||
| If not otherwise specified (see below), files in this repository fall under the following license: | ||
|
|
||
| ## Install | ||
|
|
||
| The quickest way to install the bundle is via the command line. If you have Git installed, you'll probably want to install with Git. With or without, you can simply copy and paste each line one by one into the Terminal instructions ( lifted from [drnic](http://github.com/drnic/ruby-on-rails-tmbundle) ): | ||
|
|
||
| ### Install with Git | ||
|
|
||
| mkdir -p ~/Library/Application\ Support/TextMate/Bundles | ||
| cd ~/Library/Application\ Support/TextMate/Bundles | ||
| git clone https://github.com/wintermi/csharp-tmbundle.git "C#.tmbundle" | ||
| osascript -e 'tell app "TextMate" to reload bundles' | ||
|
|
||
| ### Install without Git: | ||
|
|
||
| mkdir -p ~/Library/Application\ Support/TextMate/Bundles | ||
| cd ~/Library/Application\ Support/TextMate/Bundles | ||
| wget https://github.com/wintermi/csharp-tmbundle/tarball/master | ||
| tar zxf master | ||
| rm master | ||
| mv wintermi-csharp-tmbundle* "C#.tmbundle" | ||
| osascript -e 'tell app "TextMate" to reload bundles' | ||
|
|
||
| ## Download | ||
|
|
||
| If you'd like to avoid the command line altogether, you can download the bundle and install it: | ||
|
|
||
| 1. download the zip from [https://github.com/wintermi/csharp-tmbundle/zipball/master](https://github.com/wintermi/csharp-tmbundle/zipball/master) | ||
| 2. find the zip file on your local machine and double-click to unzip it | ||
| 3. change the file name from *wintermi-csharp-tmbundle-really_long_alpha_numeric_sequence* to *C#.tmbundle* (with a dot rather than a hyphen). | ||
| 4. double-click the *C#.tmbundle* file | ||
| 5. open TextMate and select the following menu item: *Bundles > Bundle Editor > Reload Bundles* | ||
| 6. show the Bundle Editor (*Bundles > Bundle Editor > Show Bundle Editor*) | ||
| 7. scroll through the list of bundles to confirm that the bundle has been properly installed | ||
|
|
||
| ## Known Issues | ||
|
|
||
| * Mathematical Operators are missing from the symbol list | ||
| * Properties where '{' are on a new line aren't in the symbol list | ||
| * Methods with generics in the name are missing from the symbol list | ||
| * Certain methods, e.g. TimeSpan.FromSeconds() are incorrectly added to the symbol list | ||
| * Method signature variables with generic types aren't correctly *italicized* in TextMate 2 | ||
| * Method signatures with array [] aren't correctly *italicized* (though array[] works) in TextMate 2 | ||
| * Method calls do not correctly highlight out and ref keywords (though method signatures do) | ||
|
|
||
| ## Other Stuff | ||
|
|
||
| * You can [report a bug or request a feature here](https://github.com/wintermi/csharp-tmbundle/issues) | ||
|
|
||
| ## History | ||
|
|
||
| * Rewrite of the original C# bundle heavily inspired by the Java bundle in readiness for TextMate 2.x | ||
| * Removed TextMate 1.x bundle as no longer supported | ||
| Permission to copy, use, modify, sell and distribute this | ||
| software is granted. This software is provided "as is" without | ||
| express or implied warranty, and with no claim as to its | ||
| suitability for any purpose. | ||
|
|
||
| An exception is made for files in readable text which contain their own license information, or files where an accompanying file exists (in the same directory) with a “-license” suffix added to the base-name name of the original file, and an extension of txt, html, or similar. For example “tidy” is accompanied by “tidy-license.txt”. |