Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aziz committed Feb 14, 2014
1 parent a83bcd6 commit 11f06be
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 57 deletions.
2 changes: 2 additions & 0 deletions ARCHIVE.todo
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ Archive:
✔ indicate a local file @v0.4 @done (13-07-28 00:09) @project(TODO)
✔ preview a theme without uploading and by just providing the url @v0.4 @done (13-07-27 20:55) @project(TODO)
✔ ---- v. 0.3 -------------------- @done
✔ Color Adjustments and filters
✔ Scope Bar and inline editing (courtesy of @tyom)
✔ bug for color boxes @v0.2 @done (13-05-11 22:56)
✔ refactor save button @done (13-05-01 23:22)
✔ refactor drag and drop @done (13-05-01 23:22)
Expand Down
66 changes: 10 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,20 @@
# TMTheme Editor
**TMTheme Editor** is a color scheme editor for [SublimeText][1], [Textmate][2] and bunch of other text editors.
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.

**NOTE**: Only works in **Google Chrome** at the moment since HTML5 APIs it uses are not available in other browsers yet.

### TRY IT OUT HERE: [tmtheme-editor.herokuapp.com](http://tmtheme-editor.herokuapp.com/)

![](http://f.cl.ly/items/1b0R3B180Z3y2X0d103A/ss03.png)

## New in Version 0.3:

#### Color Adjustments and filters

![](http://f.cl.ly/items/1N0z1l2H1a2e3s3r463P/Screen%20Shot%202013-07-26%20at%202.08.11%20PM.png)

#### Scope Bar and inline editing (courtesy of [@tyom](https://github.com/tyom))

![](http://f.cl.ly/items/1T0B3K0t2b0t071v1w3W/Screen%20Shot%202013-07-26%20at%202.08.44%20PM.png)


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.
# [TMTheme Editor](http://tmtheme-editor.herokuapp.com/)

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.
**TMTheme Editor** is a color scheme editor for [SublimeText](http://www.sublimetext.com/),
[Textmate](http://macromates.com/) and bunch of other text editors.
It allows you to edit `tmtheme` files easier and faster. it's written in [coffeescript](http://coffeescript.org/)
using [angular.js](angularjs.org)

## TmLanguage Parser
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.

## Keyboard Shortcuts
`ctrl+n`: adds a new rule

`esc`: closes all the popovers

## HTML5 APIs used
- Blob constructing
- FileReader API
- fileWriter API
- filesystem API
- file saver API
- Drag and Drop API

written in [coffeescript](http://coffeescript.org/) using [angular.js](angularjs.org)


## Install

```bash
git clone [email protected]:aziz/tmTheme-Editor.git
cd tmTheme-editor
./start.sh
```
**NOTE**: Only works in **Google Chrome** at the moment since HTML5 APIs it uses are not available in other browsers yet.

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

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

## Copyright
**TMThemeEditor**
© Copyright 2012-2013 Allen Bargi
**tmThemeEditor**
© Copyright 2012-2014 Allen Bargi

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

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

[1]: http://www.sublimetext.com/
[2]: http://macromates.com/
2 changes: 1 addition & 1 deletion TODO.todo
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

TODO v. 0.5:
☐ update readme
☐ update readme/screenshots
☐ add changelog

☐ BUG: save does not work (gallery/local/external)
Expand Down
Binary file removed public/images/Screen Shot.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/screenshots/tmte-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 11f06be

Please sign in to comment.