Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added some instructions in the README.

  • Loading branch information...
commit b3dde0de0b9ff13a7ef639dd1430212e81b2fcd9 1 parent 405b1b0
@mickael-menu authored
Showing with 37 additions and 2 deletions.
  1. +37 −2 README.md
View
39 README.md
@@ -1,2 +1,37 @@
-TikZ-Editor
-===========
+TikZ Editor
+===========
+
+TikZ Editor is a free code editor for the LaTeX graphic package TikZ.
+
+![Main Window](http://github.com/mickael-menu/TikZ-Editor/wiki/images/screenshot1.png)
+
+
+Features
+--------
+
+- Real-time preview of TikZ sources.
+- Syntax highlighting for LaTeX/TikZ.
+- Customizable code snippets.
+- Feedback of LaTeX typesetting errors using source annotations and margin markers.
+- Separated edition of TikZ source and LaTeX preamble.
+
+
+Dependencies
+------------
+
+- [Python](http://www.python.org/) version 2.6 or higher
+- [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt) version 4.3 or higher
+- [QScintilla](http://www.riverbankcomputing.com/software/qscintilla) version 2.6 or higher
+- (Linux only) [ImageMagick](http://www.imagemagick.org/)
+
+
+License
+-------
+
+Copyright © 2012 Mickaël Menu
+
+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 2 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/>.
Please sign in to comment.
Something went wrong with that request. Please try again.