diff options
| author | Damien George <damien@micropython.org> | 2021-07-09 12:38:25 +1000 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2021-07-12 17:07:36 +1000 |
| commit | 4d546713ec8858cbf908de45de11cbfc46a20971 (patch) | |
| tree | fda10704c197bf3500f09297d29239c15f878fab /shared/memzip/README.md | |
| parent | 925878b2f83e09987bd1688746b92898ee8bbcac (diff) | |
shared: Introduce new top-level dir and move 1st party lib code there.
This commit moves all first-party code developed for this project from lib/
to shared/, so that lib/ now only contains third-party code.
The following directories are moved as-is from lib to shared:
lib/libc -> shared/libc
lib/memzip -> shared/memzip
lib/netutils -> shared/netutils
lib/timeutils -> shared/timeutils
lib/upytesthelper -> shared/upytesthelper
All files in lib/embed/ have been moved to shared/libc/.
lib/mp-readline has been moved to shared/readline.
lib/utils has been moved to shared/runtime, with the exception of
lib/utils/printf.c which has been moved to shared/libc/printf.c.
Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'shared/memzip/README.md')
| -rw-r--r-- | shared/memzip/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/shared/memzip/README.md b/shared/memzip/README.md new file mode 100644 index 000000000..287d0fc48 --- /dev/null +++ b/shared/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) +``` + |
