aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClyne Sullivan <clyne@bitgloo.com>2021-10-22 08:18:55 -0400
committerClyne Sullivan <clyne@bitgloo.com>2021-10-22 08:18:55 -0400
commit7737afa6c225d947e02893c1698cc76a4b4ca4b1 (patch)
tree8088917d71961b577a175ec081a29569b9173f84
parent67f3a6c9896a5651e00eb22ee6e036c536aa0587 (diff)
update readme
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 48b5606..97c6edb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
# lib430core
-A small library for executing MSP430-targeted binaries
+
+`lib430core` provides the ability to execute binaries built for the MSP430 architecture on non-MSP430 hardware. This library only aims to reliably support the MSP430's CPU or instruction set: this is *not* meant to become a complete virtualization of MSP430 chips with peripheral support.
+
+The intended purpose of this library is to allow for a kind of "sandboxing", or process isolation. The host has complete control over the state and 16-bit memory space of a `lib430core` process, and can memory-map custom interfaces, control execution state and speed, and manage process memory at run time (e.g. paging).
+
+## Building
+
+To build `lib430core`, simply run `make`. The top of the Makefile can be edited to change the toolchain and compiler flags used.
+
+`make` produces a `lib430core.a` which may be linked into other code.
+
+Tests are in the `test` directory, which has its own Makefile.