added shipping
authorBrendan Hansen <brendan.f.hansen@gmail.com>
Fri, 26 Nov 2021 16:40:02 +0000 (10:40 -0600)
committerBrendan Hansen <brendan.f.hansen@gmail.com>
Fri, 26 Nov 2021 16:40:02 +0000 (10:40 -0600)
docs/shipping [new file with mode: 0644]
docs/todo

diff --git a/docs/shipping b/docs/shipping
new file mode 100644 (file)
index 0000000..da6618a
--- /dev/null
@@ -0,0 +1,17 @@
+This file discusses what Onyx will look like in its shipped form, on Windows, MacOS and Linux.
+
+Windows ---------------------------------------------------------
+Things that are needed:
+    * onyx.exe exists in the path
+    * onyx.exe knows where the core modules are installed (%APPDATA%\Local ?)
+
+MacOS   ---------------------------------------------------------
+I know nothing about shipping portable things on MacOS...
+
+Linux   ---------------------------------------------------------
+The way that build.sh installs Onyx on Linux is pretty close to the long term solution. That being,
+copying the core library to /usr/share/onyx/core and the necessary dependencies (libwasmer at the
+moment) to /usr/share/onyx/lib, and the executable to /usr/bin/onyx. This feels pretty intact with
+how most things are shipped on Linux. The only change I would have would be to copy things to
+/usr/local/... instead of /usr/... just to avoid possible conflicts.
+
index 9944c3d6efabcc5c1c4fa52f17ca97b85213b485..0dd4f0895f934d6ee4265c97434690d959052be1 100644 (file)
--- a/docs/todo
+++ b/docs/todo
@@ -12,7 +12,7 @@ Command Line Interface:
     [X] Remove old code from CLI logic
     [X] Add statistic printing
     [X] Fix documentation generation (broken since compiler architecture change) 
-    [ ] Add automated running component
+    [X] Add automated running component (this is built into the compiler now)
         - Store to temporary file (OS independent)
         - Detect / choose WASM backend
         - Run it
@@ -205,7 +205,7 @@ Wishlist:
     [X] #operator ^[]
         - Taking the pointer to an offset with a subscript
         - Useful for map.get_ptr (^arr[10] or ^people["John"])
-    [ ] Complete the set of combinations of procedure declaration syntaxes
+    [X] Complete the set of combinations of procedure declaration syntaxes
         - Currently (x: i32) => { ... } isn't legal.
     [X] #init functions (run before main, added to list at compile time, emitted with __run_init_procedures())
     [ ] Tests for new language features