Skip to content

Commit 11f06be

Browse files
committed
updated readme
1 parent a83bcd6 commit 11f06be

File tree

12 files changed

+13
-57
lines changed

12 files changed

+13
-57
lines changed

ARCHIVE.todo

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Archive:
4848
✔ indicate a local file @v0.4 @done (13-07-28 00:09) @project(TODO)
4949
✔ preview a theme without uploading and by just providing the url @v0.4 @done (13-07-27 20:55) @project(TODO)
5050
✔ ---- v. 0.3 -------------------- @done
51+
✔ Color Adjustments and filters
52+
✔ Scope Bar and inline editing (courtesy of @tyom)
5153
✔ bug for color boxes @v0.2 @done (13-05-11 22:56)
5254
✔ refactor save button @done (13-05-01 23:22)
5355
✔ refactor drag and drop @done (13-05-01 23:22)

README.md

Lines changed: 10 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,20 @@
1-
# TMTheme Editor
2-
**TMTheme Editor** is a color scheme editor for [SublimeText][1], [Textmate][2] and bunch of other text editors.
3-
It started as a personal experiment trying to use new HTML5 File APIs in Chrome and Angular.js. It allows you to edit `tmtheme` files easier and faster.
41

5-
**NOTE**: Only works in **Google Chrome** at the moment since HTML5 APIs it uses are not available in other browsers yet.
6-
7-
### TRY IT OUT HERE: [tmtheme-editor.herokuapp.com](http://tmtheme-editor.herokuapp.com/)
8-
9-
![](http://f.cl.ly/items/1b0R3B180Z3y2X0d103A/ss03.png)
10-
11-
## New in Version 0.3:
12-
13-
#### Color Adjustments and filters
14-
15-
![](http://f.cl.ly/items/1N0z1l2H1a2e3s3r463P/Screen%20Shot%202013-07-26%20at%202.08.11%20PM.png)
16-
17-
#### Scope Bar and inline editing (courtesy of [@tyom](https://github.com/tyom))
18-
19-
![](http://f.cl.ly/items/1T0B3K0t2b0t071v1w3W/Screen%20Shot%202013-07-26%20at%202.08.44%20PM.png)
20-
21-
22-
You can add your color scheme using the `Open` button (which does not upload anything to any server, but only allows the page to have access to the file. You can also drag and drop the file on to the page) and start tweaking the colors, add or remove rules and see the effect instantly on the preview pane.
2+
# [TMTheme Editor](http://tmtheme-editor.herokuapp.com/)
233

24-
As soon as you add a color scheme to the editor it saves the file using the File System API so that you can refresh the page and still have the color scheme loaded. Whenever you're happy with your changes you can save them so that editor can persist it on the disk. To get back the new tmtheme file you can click `Download` button and use it in your editor.
4+
**TMTheme Editor** is a color scheme editor for [SublimeText](http://www.sublimetext.com/),
5+
[Textmate](http://macromates.com/) and bunch of other text editors.
6+
It allows you to edit `tmtheme` files easier and faster. it's written in [coffeescript](http://coffeescript.org/)
7+
using [angular.js](angularjs.org)
258

26-
## TmLanguage Parser
27-
As a side project I started to write a tmLanguage parser in javascript to be able to highlight text files based on the color scheme inside the browser. it's a work in progress and has a lot of problems mainly because of javascript limited regular expression engine. I appreciate if you can help me improve it by sending a pull request.
28-
29-
## Keyboard Shortcuts
30-
`ctrl+n`: adds a new rule
31-
32-
`esc`: closes all the popovers
33-
34-
## HTML5 APIs used
35-
- Blob constructing
36-
- FileReader API
37-
- fileWriter API
38-
- filesystem API
39-
- file saver API
40-
- Drag and Drop API
41-
42-
written in [coffeescript](http://coffeescript.org/) using [angular.js](angularjs.org)
43-
44-
45-
## Install
46-
47-
```bash
48-
git clone git@github.com:aziz/tmTheme-Editor.git
49-
cd tmTheme-editor
50-
./start.sh
51-
```
9+
**NOTE**: Only works in **Google Chrome** at the moment since HTML5 APIs it uses are not available in other browsers yet.
5210

53-
The `start` script will:
11+
### [tmtheme-editor.herokuapp.com](http://tmtheme-editor.herokuapp.com/)
5412

55-
- Run `npm install` if *node_modules* is missing;
56-
- Bring up the express server at [http://localhost:9999](http://localhost:9999)
13+
![TmTheme Editor Screenshot](public/images/screenshots/tmte-screenshot.png)
5714

5815
## Copyright
59-
**TMThemeEditor**
60-
© Copyright 2012-2013 Allen Bargi
16+
**tmThemeEditor**
17+
© Copyright 2012-2014 Allen Bargi
6118

6219
This program is free software: you can redistribute it and/or modify
6320
it under the terms of the GNU Affero General Public License as
@@ -71,6 +28,3 @@ GNU Affero General Public License for more details.
7128

7229
You should have received a copy of the GNU Affero General Public License
7330
along with this program. If not, see <http://www.gnu.org/licenses/>.
74-
75-
[1]: http://www.sublimetext.com/
76-
[2]: http://macromates.com/

TODO.todo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
TODO v. 0.5:
3-
☐ update readme
3+
☐ update readme/screenshots
44
☐ add changelog
55

66
☐ BUG: save does not work (gallery/local/external)

public/images/Screen Shot.png

-133 KB
Binary file not shown.
44.3 KB
Loading
21.6 KB
Loading

0 commit comments

Comments
 (0)