summaryrefslogtreecommitdiffhomepage
path: root/src/3p/README
diff options
context:
space:
mode:
authorMichael Smith <mikesmiffy128@gmail.com>2021-11-20 03:10:50 +0000
committerMichael Smith <mikesmiffy128@gmail.com>2021-11-20 03:18:08 +0000
commitda6f343032cb01597dc7866e66f091adf3243a62 (patch)
tree870f8cb8e82bb42202ab92bea03fc6ab35ada7ca /src/3p/README
Initial public snapshot
With code from Bill. Thanks Bill!
Diffstat (limited to 'src/3p/README')
-rw-r--r--src/3p/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/3p/README b/src/3p/README
new file mode 100644
index 0000000..85b225c
--- /dev/null
+++ b/src/3p/README
@@ -0,0 +1,24 @@
+These are imported 3rd party library sources, wrangled for ease of plonking into
+the build (e.g. relative #includes, etc.).
+
+Used in SST itself:
+ - libmpack
+ - monocypher
+ - udis86
+
+Used at build time:
+ - chibicc (somewhat hacked up for use as a lexer)
+ - asprintf() from OpenBSD (for compatibility on Windows)
+
+Most of the C sources have wrappers in the parent directory to build proper
+objects for use in the project, and wrapper headers to get the full APIs as
+conveniently as possible. In other words, most of these files aren't built or
+used directly.
+
+It is possible that these libraries may end up lightly modified; we err on the
+side of changing things to fit our use case rather than working around problems
+in outer layers. A couple of the libraries are pretty old and don't see much
+upstream change, but are small enough to be comfortably maintained as vendored.
+
+IMPORTANT! Libraries are distributed subject to their copyright notices; please
+refer to those!