changeset 527:61f31b998e85

Updated the readme file. git-svn-id: svn://svn.code.sf.net/p/universalindent/code/trunk@767 59b1889a-e5ac-428c-b0c7-476e01d41282
author thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
date Sun, 21 Sep 2008 20:31:52 +0000
parents 4ca2b3794fa5
children 7a1b429fd4e7
files README.txt
diffstat 1 files changed, 44 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Sun Sep 21 19:53:40 2008 +0000
+++ b/README.txt	Sun Sep 21 20:31:52 2008 +0000
@@ -7,13 +7,35 @@
 1. About UniversalIndentGUI
 ---------------------------
 
-The UniversalIndentGUI is a universal graphical user interface for source code, respective text, formatters, beautifiers and indenters. This is mainly achieved by a configuration file for each supported indenter.
+The UniversalIndentGUI is a universal graphical user interface for source code respective text formatters, beautifiers and indenters. This is mainly achieved by a configuration file for each supported indenter.
 
-One of the main features and the reason why this tool was (better is being right now) developed is to see how the indent parameter affects the source code style directly while changing the parameters. It always bothered me to change one option of a tool like GNU Indent or GreatCode and have to run it to see what my code would look like afterward. Often the result was not what I expected from the parameters description. So these times are gone. Toggle a parameter and see what it does.
+One of the main features and the reason why this tool was (better is being) developed is to see how the indent parameters affect the source code style, directly while changing the parameters. It always bothered me to change one option of a tool like GNU Indent or GreatCode and have to run it to see what my code would look like afterward. Often the result was not what I expected from the parameters description. So these times are gone. Toggle a parameter and see what it does.
 
 
 2. Features
 -----------
+- Supports the following indenters:
+  * Artistic Styler
+  * BCPP
+  * Cobol Beautifier
+  * CSS Tidy
+  * GNU Indent
+  * GreatCode
+  * HIndent
+  * HTB
+  * JsDecoder
+  * Perl Tidy
+  * PHP Beautifier
+  * phpCB
+  * PHP Stylist
+  * Ruby Beautify
+  * Ruby Formatter
+  * Shell Indent
+  * (HTML) Tidy
+  * Uncrustify
+
+- By these indenters the following programming languages are supported:
+  C, C++, C#, Cobol, CSS, D, HTML, JAVA, Javascript, ObjectiveC, Pawn, Perl, PHP, Ruby, Shellscript, VALA, XML and XSL.
 
 - Directly see how the code/text is affected by a indenter parameter
 
@@ -21,6 +43,8 @@
 
 - Indenter settings can be saved into the indenters own config file format (in case of GreatCode this is for example the file "gc.cfg")
 
+- Create shell/batch scripts which make it easy to format whole directories with the selected indenters settings. Also these scripts can be called from within every application.
+
 - Not yet known indenters can be added by creating a ini file for them, that is used by UniversalIndentGUI (this file has the prefix "uigui_" and ends with ".ini"). Have a look at the file "doc/iniFileFormat.html" for explanations about the ini file format. If you want to extend an existing or create a new ini file for a new indenter, you are sincerely invited to do so and I would be thankful for telling me about it.
 
 
@@ -34,7 +58,14 @@
 Right now the windows version of GreatCode is shipped along with the Linux version of UniversalIndentGUI, because I was unable to compile GreatCode under Linux. UniversalIndentGUI tries to start GreatCode via wine. So wine has to be installed in order to use GreatCode. This applies to any new indenter, where only a windows executable exists, too.
 
 3.1 Parameters
-UniversalIndentGUI can be started with a file as parameter, which is loaded on startup.
+UniversalIndentGUI can be started with different parameters. The mentioned server component is currently in a very early development state. Its intention is to open UiGUI for plugins that can communicate from for example any editor via TCP/IP with the indenting component. Later more about that.
+
+The following parameters can be used:
+    No parameters starts without server and full gui.
+    -f filename --file filename   : Opens the by filename defined file on start.
+    -p --plugin  : Run as plugin. Server will be startet with a simplified gui.
+    -s --server  : Run as server only without gui.
+    If -p and -s are set, -p will be used.
 
 3.2 Portable mode
 UniversalIndentGUI can be run in a portable mode, so it won't make any modifications on the system, except for the media it is started from. The things UniversalIndentGUI writes to the for example USB drive are the user settings of the application and the set parameters of the indenters. Further a temporary dir is used, to feed the indenters with input files and grab their output.
@@ -63,7 +94,7 @@
 Directory: trunk
 As one path: https://universalindent.svn.sourceforge.net/svnroot/universalindent/trunk
 
-The Qt Framework Version >=4.3.x with source code is needed for compiling. It is available at www.trolltech.com. Please look there for more information. And pay attention, that there exist a commercial and a free GPL version of the Qt framework.
+The Qt Framework Version >=4.4.x with source code is needed for compiling. It is available at www.trolltech.com. Please look there for more information. And pay attention, that there exist a commercial and a free GPL version of the Qt framework.
 
 The second needed library comes from the QScintilla project (http://www.riverbankcomputing.co.uk/qscintilla/). Since I am using Qt4 there is also need to use the Qt4 version of QScintilla which is called QScintilla v2. The latest version is allways available at http://www.riverbankcomputing.com/Downloads/Snapshots/QScintilla2/ and most of the time there is no problem using that snapshot.
 
@@ -92,13 +123,20 @@
 return formattedCode;
 
 
-6. Some words at the end
+6. Future plans
+---------------
+- As mentioned above a server mode is in preparation. The protocol that will be documented when its finished.
+
+- Te whole architectue will be refactored so that the code viewing component can be flexible replaced. This is needed because I plan to integrate a diff view where the difference between original and formatted code is directly highlighted.
+
+
+7. Some words at the end
 ------------------------
 
 Feel happily invited to try out and comment UniversalIndentGUI. Good and bad critics are welcome, if they are helpful of course ;-)
 
 
-7. Disclaimer
+8. Disclaimer
 -------------
 
 You may use this software on your own risk. I am not responsible for any system damage or loss of data. Respect the GPL!