aboutsummaryrefslogtreecommitdiff
path: root/docs/libraries.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-11-29 14:18:07 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-11-29 14:18:07 -0500
commitbb2f890fd470fff3e42698710b56c68164491d85 (patch)
tree13de7c4402037f0b655ddc809fad6e23454501fe /docs/libraries.md
parent6db7b88c930657c38512709f808b422d39484a12 (diff)
Overhaul to versioning system (paths go tov2025-11-29
`/tomo@TOMOVERSION/lib@LIBVERSION` instead of using underscores. Tomo versioning now uses date-based versions.
Diffstat (limited to 'docs/libraries.md')
-rw-r--r--docs/libraries.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/libraries.md b/docs/libraries.md
index 79477070..fc1eb4ea 100644
--- a/docs/libraries.md
+++ b/docs/libraries.md
@@ -151,8 +151,7 @@ that can be used by other Tomo projects. You can build a library by running
If you additionally add the `-I` flag, Tomo will copy the entire directory
(excluding files and directories that begin with `.` such as `.git`) into
-`~/.local/lib/tomo_vX.Y/` (where `X` and `Y` are the major/minor
-version of the compiler).
+`~/.local/lib/tomo@vTOMO_VERSION/LIBRARY_NAME@LIBRARY_VERSION`.
### Using Shared Libraries
@@ -167,13 +166,13 @@ read from the source files during compilation.
When you build and install a library, its version is determined from a
`CHANGES.md` file at the top level of the library directory (see:
[Versions](versions.md)). The library's version number is added to the file
-path where the library is installed, so if the library `foo` has version
+path where the library is installed, so if the library `mylib` has version
`v1.2`, then it will be installed to
-`~/.local/lib/tomo_vX.Y/foo_v1.2/`. When using a library, you must
+`~/.local/lib/tomo@TOMO_VERSION/mylib@v1.2/`. When using a library, you must
explicitly supply either the exact version in the `use` statement like this:
-`use foo_v1.2`, or provide a `modules.ini` file that lists version information
-and other details about modules being used. For each module, you should provide
-a `[modulename]` section with a `version=` field.
+`use mylib@v1.2`, or provide a `modules.ini` file that lists version
+information and other details about modules being used. For each module, you
+should provide a `[modulename]` section with a `version=` field.
```tomo
# File: foo.tm