aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Hill <bitbucket@bruce-hill.com>2018-07-23 15:54:27 -0700
committerBruce Hill <bitbucket@bruce-hill.com>2018-07-23 15:54:27 -0700
commit278b004d17830c7be7b329d7036cf82a246039fd (patch)
tree4d278c2f1cb011ccba2499bc8f004fab5096f4fe
parent4c8a8a0fe1f1aa042f48b196aef38cfaa3ef3158 (diff)
Added more file descriptions.
-rw-r--r--README.md2
-rwxr-xr-xtools/autoformat.nom6
-rwxr-xr-xtools/find_action.nom5
-rwxr-xr-xtools/parse.nom4
-rwxr-xr-xtools/test.nom4
-rwxr-xr-xtools/upgrade.nom6
6 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
index 26301da..5f6b7c7 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,8 @@ All `.moon` files have been precompiled into corresponding `.lua` files, so you
* `examples/how_do_i.nom` - A simple walkthrough of some of the features of Nomsu, written in Nomsu code. **This is a good place to start.**
* `core/*.nom` - Core language definitions of stuff like control flow, operators, and metaprogramming, broken down into different files.
* `lib/*.nom` - Optional language libraries for stuff you might want, like interfacing with the OS, or doing Object Oriented Programming.
+* `compatibility/*.nom` - Code for automatically upgrading Nomsu code from old versions to the current version.
+* `tools/*.nom` - A set of utilities useful for doing code manipulation actions.
* `Makefile` - Rules for building/installing the compiler.
* `LICENSE` - The software license (MIT).
* `README.md` - This file.
diff --git a/tools/autoformat.nom b/tools/autoformat.nom
index 971aec3..6f8e0c2 100755
--- a/tools/autoformat.nom
+++ b/tools/autoformat.nom
@@ -1,4 +1,10 @@
#!/usr/bin/env nomsu -V2.5.4.3
+#
+ Auto-format Nomsu code. Usage:
+ nomsu tools/autoformat.nom [-i] file1 file2 directory1 ...
+ If the first argument is "-i", modifications will be performed in-place. Otherwise,
+ the formatted code will be printed.
+
use "lib/os.nom"
%args = (command line args)
diff --git a/tools/find_action.nom b/tools/find_action.nom
index 716fc9f..0d7ac4f 100755
--- a/tools/find_action.nom
+++ b/tools/find_action.nom
@@ -1,4 +1,9 @@
#!/usr/bin/env nomsu -V2.5.4.3
+#
+ Find an action by its stub. Usage:
+ nomsu tools/find_action.nom "foo %" file1 file2 directory1 ...
+ Will print all the code locations and code that uses the stub.
+
use "lib/os.nom"
use "lib/consolecolor.nom"
diff --git a/tools/parse.nom b/tools/parse.nom
index 2c70f71..a79635f 100755
--- a/tools/parse.nom
+++ b/tools/parse.nom
@@ -1,4 +1,8 @@
#!/usr/bin/env nomsu -V2.5.4.3
+#
+ Tool to print out a parse tree of files in an easy-to-read format. Usage:
+ nomsu tools/parse.nom file1 file2 directory1 ...
+
use "lib/os.nom"
action [print tree %t at indent %indent]:
diff --git a/tools/test.nom b/tools/test.nom
index 1cad598..c6c21fa 100755
--- a/tools/test.nom
+++ b/tools/test.nom
@@ -1,4 +1,8 @@
#!/usr/bin/env nomsu -V2.5.4.3
+#
+ Tool to run all tests in a file (i.e. the code block inside a call to 'test %'). Usage:
+ nomsu tools/test.nom file1 file2 directory1 ...
+
use "lib/os.nom"
use "lib/consolecolor.nom"
diff --git a/tools/upgrade.nom b/tools/upgrade.nom
index a051818..85d4a26 100755
--- a/tools/upgrade.nom
+++ b/tools/upgrade.nom
@@ -1,4 +1,10 @@
#!/usr/bin/env nomsu -V2.5.4.3
+#
+ Tool to automatically update code from old versions of Nomsu. Usage:
+ nomsu tools/upgrade.nom [-i] file1 file2 directory1 ...
+ If "-i" is the first argument, upgrades will be performed in-place. Otherwise, the
+ upgraded code will be printed.
+
use "compatibility"
use "lib/os.nom"