From 5b8f8868f107ce7e67ce65a0e6dd628849bab286 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Wed, 5 Jun 2019 12:35:42 +0200
Subject: [PATCH] WIP: Update README

---
 README.md              | 12 ++++++++++-
 ports/card10/README.md | 47 ------------------------------------------
 2 files changed, 11 insertions(+), 48 deletions(-)
 delete mode 100644 ports/card10/README.md

diff --git a/README.md b/README.md
index 3b05c8f7f..d43a79a20 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,14 @@
 micropython fork with card10 support
 ------------------------------------
 
-Original README in [`README-OLD.md`](./README-OLD.md)
+Original README in [`README-OLD.md`](./README-OLD.md).
+`card10` specific code is in [`ports/card10`](./ports/card10).
+
+## Building
+
+Build the card10 port using
+```bash
+cd ports/card10
+make SDK_LOCATION=/path/to/firmware/sdk
+```
+If everything goes well, you'll end up with a file `ports/card10/build/firmware.elf`.
diff --git a/ports/card10/README.md b/ports/card10/README.md
deleted file mode 100644
index 356fc4b3e..000000000
--- a/ports/card10/README.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# The minimal port
-
-This port is intended to be a minimal MicroPython port that actually runs.
-It can run under Linux (or similar) and on any STM32F4xx MCU (eg the pyboard).
-
-## Building and running Linux version
-
-By default the port will be built for the host machine:
-
-    $ make
-
-To run the executable and get a basic working REPL do:
-
-    $ make run
-
-## Building for an STM32 MCU
-
-The Makefile has the ability to build for a Cortex-M CPU, and by default
-includes some start-up code for an STM32F4xx MCU and also enables a UART
-for communication.  To build:
-
-    $ make CROSS=1
-
-If you previously built the Linux version, you will need to first run
-`make clean` to get rid of incompatible object files.
-
-Building will produce the build/firmware.dfu file which can be programmed
-to an MCU using:
-
-    $ make CROSS=1 deploy
-
-This version of the build will work out-of-the-box on a pyboard (and
-anything similar), and will give you a MicroPython REPL on UART1 at 9600
-baud.  Pin PA13 will also be driven high, and this turns on the red LED on
-the pyboard.
-
-## Building without the built-in MicroPython compiler
-
-This minimal port can be built with the built-in MicroPython compiler
-disabled.  This will reduce the firmware by about 20k on a Thumb2 machine,
-and by about 40k on 32-bit x86.  Without the compiler the REPL will be
-disabled, but pre-compiled scripts can still be executed.
-
-To test out this feature, change the `MICROPY_ENABLE_COMPILER` config
-option to "0" in the mpconfigport.h file in this directory.  Then
-recompile and run the firmware and it will execute the frozentest.py
-file.
-- 
GitLab