From ecc1c220836cda0464693a8042d1c9d0b677ba7d Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Tue, 1 Oct 2024 12:42:27 +0900 Subject: [PATCH] Add README.md and update readme.html Signed-off-by: Michele Calgaro (cherry picked from commit e1c968dbf1799ed765a457760b873a336a59c119) --- README.md | 36 +++++++++++++ readme.html | 144 +++------------------------------------------------- 2 files changed, 42 insertions(+), 138 deletions(-) create mode 100755 README.md diff --git a/README.md b/README.md new file mode 100755 index 0000000..4aa7d84 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# UniversalIndentGUI-TQt +A GUI frontend for several code formatters, beautifiers and indenters + +Ever concerned about how your code looks like? +Ever heard of different indenting styles, for example K&R? +Ever received code from someone else who didn't care about code formatting? +Ever tried to configure a code indenter to convert such code to your coding style? +Ever got bored by that tedious "changing a parameter"-"call the indeter"-"try and error" procedure? + +Help is close to you. UniversalIndentGUI-TQt 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. + +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. + +Thus UniversalIndentGUI-TQt 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. + +## Features + +* Live Preview: change an indenter parameter and directly see how your formatted code will look like. +* Support for many existing indenter possible. +* Easy adding of new indenters: just create a parameter definition file for the new indenter. +* Load and save different indenter configurations. +* Reset to indenters default parameters. +* Support for many programming languages through the various indenters +* Really easy to handle user interface. +* Tooltips for each indenter parameter. +* Creation of batch/shell scripts. +* Drag'n Drop of source code files. +* Support for many different file encodings, like Korean KOI8-R or Chinese BIG5. + +## Contributing + +If you wish to contribute to UniversalIndentGUI-TQt (TDE), you might do so: + +- TDE Gitea Workspace (TGW) collaboration tool. + https://mirror.git.trinitydesktop.org/gitea diff --git a/readme.html b/readme.html index 7670e5a..075afb9 100755 --- a/readme.html +++ b/readme.html @@ -26,7 +26,7 @@ a.external
-

UniversalIndentGUI-TQt-TQt

+

UniversalIndentGUI-TQt


Ever concerned about how your code looks like?
@@ -37,17 +37,11 @@ a.external

- Help is close to you. UniversalIndentGUI-TQt 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.
+ Help is close to you. UniversalIndentGUI-TQt 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.
- 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.
+ 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.
- Thus UniversalIndentGUI-TQt 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. + Thus UniversalIndentGUI-TQt 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.

@@ -55,144 +49,18 @@ a.external

-

- -

Supported and tested platforms

-

-

-

How to install / build UniversalIndentGUI-TQt

-

- 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, - UiGUI will run in portable mode. -

-

- But if you'd like to build UiGUI from source, follow these steps: -

    -
  1. Download, unpack, configure and compile - TQt - >= 4.4.0. Make your QTDIR and QMAKESPEC settings. Or install TQt via a package manager.
    2. -
  2. Download, unpack, compile and install - TQScintilla - >= 2.2.
    3. -
  3. Checkout UiGUI: svn co https://universalindent.svn.sourceforge.net/svnroot/universalindent/trunk universalindentgui
    4. -
  4. In the checked out directory run "qmake UniversalIndentGUI-TQt.pro".
    5. -
  5. Run "make release".
    6. -
  6. Install it
    7. -
      -
    1. - Windows and Mac:
      - For testing on Windows/Mac download the indenter binary package from sourceforge and extract it into the - directory where you checked out the code (in the upper example that is "universalindentgui"). - Then move the file "UniversalIndentGUI-TQt.exe" (on Mac the directory "UniversalIndentGUI-TQt") from the - "release" directory also to that directory. Starting UiGUI from this directory will run it - in portable mode. -
      2. -
    2. - Linux:
      - Run "sudo make install" installs for multi user mode. Install supported indenters via package manager for - example. For portable mode just skip "make install" and move the file "universalindentgui" from the "release" - directory into the directory where you checked out the code (in the upper example that is - "universalindentgui"). -
      3. -
    -
- Indenter binary packages can be downloaded from the project at SourceForge - here. -

Beneath the possibility to build UiGUI using qmake, also project files for Visual Studio 2005 - and XCode are included.

-

- -

Thanks

- 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:

-
Thank you all out there!!
- -

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! UiGUI is being released under - GPL 2. - You will also find the license in the included file "LICENSE.GPL".