summaryrefslogtreecommitdiffstatshomepage
path: root/lib/memzip/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/memzip/README.md')
-rw-r--r--lib/memzip/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/lib/memzip/README.md b/lib/memzip/README.md
new file mode 100644
index 0000000000..287d0fc489
--- /dev/null
+++ b/lib/memzip/README.md
@@ -0,0 +1,28 @@
+MEMZIP - a simple readonly file system
+
+memzip takes a zip file which is comprised of uncompressed files and
+and presents it as a filesystem, allowing Python files to be imported.
+
+The script make-memzip.py takes a directory name and will create a zip file
+containing uncompressed files found in the directory. It will then generate
+a C file which contains the data from the zip file.
+
+A typical addition to a makefile would look like:
+```
+SRC_C += \
+ lib/memzip/import.c \
+ lib/memzip/lexermemzip.c \
+ lib/memzip/memzip.c \
+
+OBJ += $(BUILD)/memzip-files.o
+
+MAKE_MEMZIP = ../lib/memzip/make-memzip.py
+
+$(BUILD)/memzip-files.o: $(BUILD)/memzip-files.c
+ $(call compile_c)
+
+$(BUILD)/memzip-files.c: $(shell find ${MEMZIP_DIR} -type f)
+ @$(ECHO) "Creating $@"
+ $(Q)$(PYTHON) $(MAKE_MEMZIP) --zip-file $(BUILD)/memzip-files.zip --c-file $@ $(MEMZIP_DIR)
+```
+