aboutsummaryrefslogtreecommitdiff
path: root/doc/manual.md
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2017-02-12 21:45:36 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2017-02-12 21:45:36 -0500
commita472687ecd4baa1fbbd82e5d6994fa3671387f83 (patch)
tree911aee71042d85c8b008bb29c0197502fc20fd96 /doc/manual.md
parent36781b31377cb5f8841c7757b70656801e9808bf (diff)
downloadtextadept-a472687ecd4baa1fbbd82e5d6994fa3671387f83.tar.gz
textadept-a472687ecd4baa1fbbd82e5d6994fa3671387f83.zip
Improved build for when dependencies are updated, and added summary to manual.
Diffstat (limited to 'doc/manual.md')
-rw-r--r--doc/manual.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/manual.md b/doc/manual.md
index 685a38c1..bf73cea7 100644
--- a/doc/manual.md
+++ b/doc/manual.md
@@ -1670,6 +1670,24 @@ cross-compiling from Linux. In order to do so, you need the
## Compiling
+### Makefile Command Summary
+
+The following table provides a brief summary of `make` or `gmake` rules for
+building Textadept. Subsequent sections contain more detailed descriptions,
+including platform-specific rules and options.
+
+Command |Description
+---------------------|-----------
+`make deps` |Downloads and builds all of Textadept's core dependencies
+`make verify-deps` |Verifies integrity of downloads (for optional security)
+`make` |Builds Textadept, provided all dependencies are in place
+`make install` |Installs Textadept (to */usr/local* by default)
+`make curses` |Builds the terminal version of Textadept
+`make curses install`|Installs the terminal version of Textadept
+`make uninstall` |Uninstalls Textadept (from */usr/local* by default)
+`make clean` |Deletes all compiled files, leaving only source files
+`make clean-deps` |Deletes all unpacked dependencies, leaving only downloads
+
### Compiling on Linux and BSD
Note: for BSD systems, replace the `make` commands below with `gmake`.