diff options
author | mitchell <70453897+orbitalquark@users.noreply.github.com> | 2021-04-11 09:34:17 -0400 |
---|---|---|
committer | mitchell <70453897+orbitalquark@users.noreply.github.com> | 2021-04-11 09:34:17 -0400 |
commit | de3a745e1af2e441de868c2aa4849102d376acb5 (patch) | |
tree | c2d7767600dc519b2613ddecaf7e53fb5e8867a2 /README.md | |
parent | 03fab17277fee7387fd93a9c2774b1ebf3f80fe4 (diff) |
Initial pass reformatting all code.
Use clang-format, LuaFormatter, and 100 character limit on lines.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 119 |
1 files changed, 54 insertions, 65 deletions
@@ -1,13 +1,11 @@ # Textadept -Textadept is a fast, minimalist, and remarkably extensible cross-platform text -editor for programmers. Written in a combination of C and [Lua][] and -relentlessly optimized for speed and minimalism for more than 12 years, -Textadept is an ideal editor for programmers who want endless extensibility -without sacrificing speed and disk space, and without succumbing to code bloat -and a superabundance of features. The application has both a graphical user -interface (GUI) version that runs in a desktop environment, and a terminal -version that runs within a terminal emulator. +Textadept is a fast, minimalist, and remarkably extensible cross-platform text editor for +programmers. Written in a combination of C and [Lua][] and relentlessly optimized for speed and +minimalism for more than 12 years, Textadept is an ideal editor for programmers who want endless +extensibility without sacrificing speed and disk space, and without succumbing to code bloat and +a superabundance of features. The application has both a graphical user interface (GUI) version +that runs in a desktop environment, and a terminal version that runs within a terminal emulator. [Lua]: https://lua.org @@ -21,47 +19,42 @@ version that runs within a terminal emulator. * Can be entirely keyboard driven. * Powerful snippets and key commands. * Code autocompletion and documentation lookup. -* Remarkably extensible, with a heavily documented Application Programming - Interface (API). +* Remarkably extensible, with a heavily documented Application Programming Interface (API). ## Requirements -In its bid for minimalism, Textadept depends on very little to run. On Windows -and macOS, it has no external dependencies. On Linux and BSD, the GUI version -depends only on [GTK][] (a cross-platform GUI toolkit) version 2.24 or later -(circa early 2011), and the terminal version depends only on a wide-character -implementation of curses like [ncurses][](w). Lua and any other third-party -dependencies are compiled into the application itself. +In its bid for minimalism, Textadept depends on very little to run. On Windows and macOS, +it has no external dependencies. On Linux and BSD, the GUI version depends only on [GTK][] +(a cross-platform GUI toolkit) version 2.24 or later (circa early 2011), and the terminal +version depends only on a wide-character implementation of curses like [ncurses][](w). Lua and +any other third-party dependencies are compiled into the application itself. [GTK]: https://gtk.org [ncurses]: https://invisible-island.net/ncurses/ncurses.html ## Download -Textadept releases can be found [here][1]. Select the appropriate package for -your platform. A comprehensive list of changes between releases can be found -[here][2]. You can also download a separate set of modules that provide extra -features and functionality to the core application. +Textadept releases can be found [here][1]. Select the appropriate package for your platform. A +comprehensive list of changes between releases can be found [here][2]. You can also download +a separate set of modules that provide extra features and functionality to the core application. [1]: https://github.com/orbitalquark/textadept/releases [2]: https://orbitalquark.github.io/textadept/changelog.html ## Installation and Usage -Textadept comes with a comprehensive [user manual][] in its *docs/* directory. -It covers all of Textadept's main features, including installation, usage, -configuration, theming, scripting, and compilation. +Textadept comes with a comprehensive [user manual][] in its *docs/* directory. It covers all +of Textadept's main features, including installation, usage, configuration, theming, scripting, +and compilation. -Since nearly every aspect of Textadept can be scripted using Lua, the editor's -API is heavily documented. This [API documentation][] is also located in -*docs/*. It serves as the ultimate resource when it comes to scripting the -application. +Since nearly every aspect of Textadept can be scripted using Lua, the editor's API is heavily +documented. This [API documentation][] is also located in *docs/*. It serves as the ultimate +resource when it comes to scripting the application. -A more structured scripting resource is [Textadept Quick Reference][], which -contains a wealth of knowledge on how to script and configure Textadept. It -groups the editor's rich API into a series of tasks in a convenient and -easy-to-use manner. This book serves as the perfect complement to Textadept's -Manual and exhaustive API documentation. +A more structured scripting resource is [Textadept Quick Reference][], which contains a wealth +of knowledge on how to script and configure Textadept. It groups the editor's rich API into +a series of tasks in a convenient and easy-to-use manner. This book serves as the perfect +complement to Textadept's Manual and exhaustive API documentation. [user manual]: https://orbitalquark.github.io/textadept/manual.html [API documentation]: https://orbitalquark.github.io/textadept/api.html @@ -69,46 +62,44 @@ Manual and exhaustive API documentation. ## Compile -Textadept is a bit unusual in that building it is only supported on Linux and -BSD, or within a [Docker][] [image][]. The application is cross-compiled for -Windows and macOS from Linux. While it is certainly possible to compile -Textadept natively on those platforms, it is simply not supported in any -official capacity. +Textadept is a bit unusual in that building it is only supported on Linux and BSD, or within a +[Docker][] [image][]. The application is cross-compiled for Windows and macOS from Linux. While +it is certainly possible to compile Textadept natively on those platforms, it is simply not +supported in any official capacity. -Textadept is built from its *src/* directory and binaries are placed in the -application's root directory. The general procedure is to have Textadept build -its dependencies first, and then its binaries. Textadept is self-contained, -meaning you do not have to install it; it can run from its current location. +Textadept is built from its *src/* directory and binaries are placed in the application's root +directory. The general procedure is to have Textadept build its dependencies first, and then +its binaries. Textadept is self-contained, meaning you do not have to install it; it can run +from its current location. General Requirements: * [GNU C compiler][] (*gcc*) 7.1+ (circa mid-2017) * [GNU Make][] (*make*) * [GTK][] 2.24+ development libraries for the GUI version -* [ncurses][](w) development libraries (wide character support) for the terminal - version +* [ncurses][](w) development libraries (wide character support) for the terminal version * [mingw-w64][] 5.0+ with GCC 7.1+ when cross-compiling for Windows. * [OSX cross toolchain][] with [Clang][] 4.0+ when cross-compiling for macOS. * _**OR**_ * [Docker][] -The following table provides a brief list of `make` rules for building Textadept -on Linux and BSD. (On BSD, substitute `make` with `gmake`.) - -Command |Description ----------------------|----------- -`make deps` |Downloads and builds all of Textadept's core dependencies -`make deps NIGHTLY=1`|Optionally downloads and builds bleeding-edge dependencies -`make` |Builds Textadept, provided all dependencies are in place -`make GTK3=1` |Builds Textadept using GTK 3.x -`make DEBUG=1` |Optionally builds Textadept with debug symbols -`make curses` |Builds the terminal version of Textadept -`make win32-deps` |Downloads and builds Textadept's Windows dependencies -`make win32` |Cross-compiles Textadept for Windows -`make win32-curses` |Cross-compiles the terminal version for Windows -`make osx-deps` |Downloads and builds Textadept's macOS dependencies -`make osx` |Cross-compiles Textadept for macOS -`make osx-curses` |Cross-compiles the terminal version for macOS +The following table provides a brief list of `make` rules for building Textadept on Linux and +BSD. (On BSD, substitute `make` with `gmake`.) + +Command | Description +-|- +`make deps` | Downloads and builds all of Textadept's core dependencies +`make deps NIGHTLY=1` | Optionally downloads and builds bleeding-edge dependencies +`make` | Builds Textadept, provided all dependencies are in place +`make GTK3=1` | Builds Textadept using GTK 3.x +`make DEBUG=1` | Optionally builds Textadept with debug symbols +`make curses` | Builds the terminal version of Textadept +`make win32-deps` | Downloads and builds Textadept's Windows dependencies +`make win32` | Cross-compiles Textadept for Windows +`make win32-curses` | Cross-compiles the terminal version for Windows +`make osx-deps` | Downloads and builds Textadept's macOS dependencies +`make osx` | Cross-compiles Textadept for macOS +`make osx-curses` | Cross-compiles the terminal version for macOS When building within Docker, the relevant container [image][] is `ghcr.io/orbitalquark/textadept-build:v1.0`. @@ -128,12 +119,10 @@ For more information on compiling Textadept, please see the [manual][]. ## Contribute -Your [donation][] or purchase of the [book][] helps fund Textadept's continuous -development. +Your [donation][] or purchase of the [book][] helps fund Textadept's continuous development. -Textadept is [open source][]. Feel free to discuss features, report bugs, and -submit patches. You can also contact me personally -(orbitalquark.att.triplequasar.com). +Textadept is [open source][]. Feel free to discuss features, report bugs, and submit patches. You +can also contact me personally (orbitalquark.att.triplequasar.com). [donation]: https://gum.co/textadept [book]: https://orbitalquark.github.io/textadept/book.html |