Mercurial > hg > forks > UniversalIndentGUI

annotate README.md @ 796:0eee433d0084

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
new readme for a new age, also added a gitignore
author Daniel Blakemore <DanBlakemore@gmail.com>
date Tue, 17 Mar 2015 11:02:47 -0600
parents
children 718e09837d7b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
796
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
1 # UniversalIndentGUI
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
2
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
3 Ever concerned about how your code looks like?
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
4
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
5 Ever heard of different indenting styles, for example K&amp;R?
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
6
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
7 Ever received code from someone else who didn't care about code formatting?
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
8
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
9 Ever tried to configure a code indenter to convert such code to your coding style?
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
10
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
11 Ever got bored by that tedious "changing a parameter"-"call the indeter"-"try and error" procedure?
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
12
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
13 Help is close to you. UniversalIndentGUI offers a live preview for setting the parameters of nearly any indenter. You change the value of a parameter and directly see how your reformatted code will look like. Save your beauty looking code or create an anywhere usable batch/shell script to reformat whole directories or just one file even out of the editor of your choice that supports external tool calls.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
14
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
15 Many free available code beautifier, formatter and indenter are currently supported, like GNU Indent, Uncrustify, Artistic Styler, PHP Stylist, Ruby Beautify, HTML Tidy and many other (look at features for complete list). Currently not supported indenters can be easyly added by creating a configuration file for them.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
16
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
17 Thus UniversalIndentGUI is open for nearly any new indenter and programming languages. Give it a try. Perhaps you'll also find an indenter for your programming language that you even didn't know that it exists.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
18
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
19 ### Features
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
20
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
21 * Live Preview: change an indenter parameter and directly see how your formatted code will look like.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
22 * Support for nearly any existing indenter possible. Currently supported are:
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
23
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
24 ->![UiGUI Screenshot](doc/images/screenshot8.jpg)<-
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
25
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
26 * [Artistic Styler](http://astyle.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
27 * [BCPP](http://invisible-island.net/bcpp/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
28 * [Cobol Beautify](http://www.siber.com/sct/tools/cbl-beau.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
29 * [CSSTidy](http://csstidy.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
30 * [Fortran 90 PPR](ftp://ftp.ifremer.fr/ifremer/ditigo/fortran90/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
31 * [GNU Indent](http://www.gnu.org/software/indent/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
32 * [GreatCode](http://sourceforge.net/projects/gcgreatcode/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
33 * [hindent](http://packages.debian.org/de/lenny/hindent)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
34 * [HTB](http://www.digital-mines.com/htb/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
35 * [Javascript Decoder](http://code.gosu.pl/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
36 * [JSPPP](http://jsppp.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
37 * [Perl Tidy](http://perltidy.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
38 * [PHP_Beautifier](http://pear.php.net/package/PHP_Beautifier)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
39 * [PHP Code Beautifier](http://www.waterproof.fr/products/phpCodeBeautifier/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
40 * [PHP Stylist](http://sourceforge.net/projects/phpstylist/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
41 * [pindent](http://coverage.livinglogic.de/Tools/scripts/pindent.py.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
42 * [Pl/Sql tidy](http://psti.equinoxbase.com/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
43 * [Ruby Beautify](http://www.arachnoid.com/ruby/rubyBeautifier.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
44 * [Ruby Formatter](http://raa.ruby-lang.org/project/ruby_formatter/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
45 * [Shell Indent](http://www.bolthole.com/AWK.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
46 * [(HTML) Tidy](http://tidy.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
47 * [Uncrustify](http://uncrustify.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
48 * [VBSBeautifier](http://www.daansystems.com/vbsbeaut/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
49 * [XML Indent](http://xmlindent.sourceforge.net/)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
50
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
51
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
52 Easy adding of new indenters: just create a parameter definition file for the new indenter.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
53
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
54 Load and save different indenter configurations.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
55
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
56 Reset to indenters default parameters.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
57
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
58 By the above named indenters currently supported programming languages:
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
59
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
60 ->![UiGUI Screenshot](doc/images/screenshot6.jpg)<-
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
61
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
62 * C, C++
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
63 * C#
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
64 * Cobol
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
65 * CSS
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
66 * D
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
67 * Fortran
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
68 * HTML
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
69 * Java
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
70 * JavaScript
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
71 * JSP
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
72 * Objective-C
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
73 * Pawn
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
74 * Perl
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
75 * PHP
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
76 * Pl/Sql
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
77 * Python
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
78 * Ruby
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
79 * Shellscript
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
80 * VALA
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
81 * Visual Basic
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
82 * XML
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
83 * XSL
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
84
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
85 Syntax highlighting for all of these languages except for Pawn and VALA
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
86
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
87 Really easy to handle user interface.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
88
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
89 Tooltips for each indenter parameter.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
90
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
91 Creation of batch/shell scripts.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
92
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
93 HTML and PDF export of your code.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
94
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
95 PortableMode and MultiUserMode: In portable mode only uses its own subdirectories for temporary writing.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
96
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
97 Multiple languages: English, German, Traditional Chinese, Russian, Ukrainian, partly Japanese.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
98 Drag'n Drop of source code files.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
99
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
100 Support for many different file encodings, like Korean KOI8-R or Chinese BIG5.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
101
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
102 Possibility to edit your code while live preview is turned on. Yeah, thats really live! (but positions cursor wrong sometimes depending on the used indenter :-( )
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
103
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
104 Code completion.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
105
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
106 Automatic update check. Does check only once a day and can be disabled.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
107
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
108 A nice about dialog. Errrmm, ok beneath all the mean stuff this is somehow the programmers playground ;-)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
109
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
110 Also a [Notepad++](http://notepad-plus.sourceforge.net/) plugin version is available.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
111 The programming project for that is currently only available as Visual Studio C++ 2005 project file.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
112
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
113 Also this plugin has some problems with its event handling, because it is running as a DLL inside of Notepad++ event loop.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
114
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
115 This will be replaced with the upcoming UiGUI server functionality. See future plans for more about that.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
116
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
117 ### Supported and tested platforms
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
118
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
119 * Windows 32 bit
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
120 * Linux 32 and 64 bit
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
121 * Mac OS X >= 10.4 (currently Intel only. PPC produced mysterious linker error)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
122
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
123 ### How to install / build UniversalIndentGUI
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
124
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
125 If you downloaded a complete binary package/archive for your system from SourceForge, you only need to unpack it and can run it out of the box. Also all free available indenters for your platform are included. Doing it that way,
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
126
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
127 UiGUI will run in portable mode.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
128
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
129 But if you'd like to build UiGUI from source, follow these steps:
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
130
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
131 1. Download, unpack, configure and compile
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
132 [Qt](http://www.qtsoftware.com/downloads/opensource/appdev)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
133 >= 4.4.0. Make your QTDIR and QMAKESPEC settings. Or install Qt via a package manager.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
134 2. Download, unpack, compile and install
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
135 [QScintilla](http://www.riverbankcomputing.com/software/qscintilla/download)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
136 >= 2.2.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
137 3. Checkout UiGUI: svn co https://universalindent.svn.sourceforge.net/svnroot/universalindent/trunk universalindentgui
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
138 4. In the checked out directory run "qmake UniversalIndentGUI.pro".
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
139 5. Run "make release".
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
140 6. Install it
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
141 **Indenter binary packages** can be downloaded from the project at SourceForge
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
142 [here](http://sourceforge.net/project/showfiles.php?group_id=167482&package_id=293094).
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
143
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
144 Beneath the possibility to build UiGUI using qmake, also project files for Visual Studio 2005
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
145 and XCode are included.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
146
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
147 ### Used Qt techniques
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
148
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
149 This list shows some selected functionalities that Qt offers and that I use with UiGUI.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
150
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
151 * Translations are done with
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
152 [QTranslator](http://doc.trolltech.com/4.4/qtranslator.html),
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
153 [QLocale](http://doc.trolltech.com/4.4/qlocale.html) and Linguist.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
154 * File encodings are supported by using
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
155 [QTextCodec](http://doc.trolltech.com/4.4/qtextcodec.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
156 and [QTextStream](http://doc.trolltech.com/4.4/qtextstream.html).
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
157 * [QScriptEngine](http://doc.trolltech.com/4.4/qscriptengine.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
158 and [QScriptValue](http://doc.trolltech.com/4.4/qscriptvalue.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
159 is included for executing JavaScript files used as indenters.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
160 * [QGraphicsView](http://doc.trolltech.com/4.4/qgraphicsview.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
161 and [QGraphicsProxyWidget](http://doc.trolltech.com/4.4/qgraphicsproxywidget.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
162 for creating an animated 3D about dialog, simulating that is done on the whole desktop by using
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
163 the screenshot capability of Qt.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
164 * Stylesheet settings give the about dialog a special look. Also gradients are used.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
165 * [QHttp](http://doc.trolltech.com/4.4/qhttp.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
166 and [QUrl](http://doc.trolltech.com/4.4/qurl.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
167 are used for the update check.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
168 * [QSettings](http://doc.trolltech.com/4.4/qsettings.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
169 is responsible for storing the application and syntax highlighter settings.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
170 * [QTcpServer](http://doc.trolltech.com/4.4/qtcpserver.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
171 and [QTcpSocket](http://doc.trolltech.com/4.4/qtcpsocket.html)
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
172 build the base for the UiGUI Server.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
173 * Of course I use the Qt tools qmake, lupdate, lrelease, Designer, Linguist and my very best friend the Assistant.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
174
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
175 ### Future plans
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
176
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
177 * Exchangeable source code view. Mainly adding a "Live Diff View" where you can see the unformatted
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
178 code and the formatted one side by side with changes highlighted.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
179 * Bring functionality to the UiGUI server so that he can be run anywhere and a client plugin in any editor
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
180 like Eclipse or Notepad++ can communicate with it. Thus the client plugin can be written in any language
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
181 supporting TCP/IP connections and send to be formatted code to the server. Also some settings might be
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
182 made via that conncection. Plans are going on, so stay tuned.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
183 * Batch/Multiple file and directory indenting, so that the user can throw a bunch of files or directories
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
184 into a list and click on "Do it", so they all will get formatted.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
185
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
186 ### Thanks
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
187
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
188 Here I'd like to say "thank you" to all those guys, who helped me improving UiGUI. May it be doing some translations, creating packages for Linux, letting me know about bugs or ways to improve or just saying that they found my application helpful and that they like it. So:
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
189
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
190 ->**Thank you all out there!!**<-
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
191
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
192 ### Disclaimer
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
193
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
194 You may use this software on your own risk. I am not responsible for any system damage or loss of data.
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
195
0eee433d0084 new readme for a new age, also added a gitignore
Daniel Blakemore <DanBlakemore@gmail.com>
parents:
diff changeset
196 Respect the GPL! UiGUI is being released under [GPL 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html). You will also find the license in the included file "LICENSE.GPL".