diff --git a/README.md b/README.md index 3fca35f081354d7affeb42f8f6c9841de8a3f379..5fca185b75338a6c457603af5e7de26a41fe8d3c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ # UNL ECEN OLED Keychain Project - - -# Prerequisites -Install [Visual Studio Code](ms-windows-store://pdp/?productid=XP9KHM4BK9FZ7Q) if not already installed. - +This repository includes the code and build materials to program the UNL ECEN OLED Keychain. JLink Programmer necessary to target the device. + # Cloning the repo - +Clone to a known or common directory. ``` git clone --recurse-submodules https://git.unl.edu/pscalise2/py32-keychain.git ``` +# Prerequisites +Install [Visual Studio Code](ms-windows-store://pdp/?productid=XP9KHM4BK9FZ7Q) if not already installed. + +Install the Cortext-Debug extension in vscode. See image below. Close vscode when the extension is installed. + + # Run the setup Puya 32 Environment Setup script (Windows) First, open Windows Powershell in *Administrator Mode*. This script will install all of the dependencies for the building, flashing, and debugging of the py32f030x8, and the other PY32 chipsets. @@ -19,6 +22,9 @@ First, open Windows Powershell in *Administrator Mode*. This script will install cd py32-keychain\puya-32-environment-setup powershell -ExecutionPolicy Bypass -File .\py32-env-setup.ps1 --AcceptSEGGERLicense ``` +Once the setup script is complete, restart vscode. +# Build and Program + More information on manual installation can be found at https://github.com/jaydcarlson/py32-template. \ No newline at end of file