aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-03-09 23:44:52 -0500
committerBruce Hill <bruce@bruce-hill.com>2024-03-09 23:44:52 -0500
commitb639f01294f8c528ad0597a179f7e426bccdfb80 (patch)
treeee312fb40488ff5bcaf43ded30b4eae21655630a /README.md
parentb83221f422721410d365a9e35b88810d6daae744 (diff)
Removing some dead code
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 22 insertions, 3 deletions
diff --git a/README.md b/README.md
index 950dff41..0a6d729b 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,25 @@ Check out the [test/](test/) folder to see some examples.
## Dependencies
-Tomo uses the [Boehm garbage collector](https://www.hboehm.info/gc/) for
-runtime garbage collection (which is available from your package manager of
-choice, for example: `pacman -S gc`).
+Tomo has a very small set of dependencies:
+
+- The [Boehm garbage collector](https://www.hboehm.info/gc/) for runtime
+ garbage collection.
+- [libunistring](https://www.gnu.org/software/libunistring/) for unicode
+ string support.
+- a C compiler
+- and libc/libm, which should definitely already be installed.
+
+Both of which should be available on your package manager of choice (for
+example, `pacman -S gc libunistring`).
+
+## Building
+
+The Tomo compiler can be compiled with either GCC or Clang by running `make`.
+
+## Running
+
+You can run a Tomo program by running `./tomo program.tm`. By default, this
+will use your environment's `$CC` variable to select which C compiler to use.
+If no C compiler is specified, it will default to `tcc` (Tiny C Compiler),
+which is exceptionally fast.