Merge pull request #3 from yuetloo/chore/add-submodules

Add display and scane components as submodules

.github/workflows/build.yml

@@ -0,0 +1,45 @@
+name: Build
+on: 
+  push:
+  workflow_dispatch:
+    inputs:
+      memory:
+        description: 'Max memory size available to docker'
+        required: true
+        default: '1g'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MAX_MEMORY_SIZE: '500m'
+    steps:
+    - name: Checkout pixie-firmware
+      uses: actions/checkout@v3
+      with:
+        ref: chore/add-submodules
+        submodules: 'recursive'
+    - name: Setup node version
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20
+    - name: Set maximum memory for 'workflow_dispatch' trigger
+      if: github.event_name == 'workflow_dispatch'
+      env:
+        MAX_MEMORY_SIZE: ${{ inputs.memory }}
+      run: echo $MAX_MEMORY_SIZE
+    - name: Verify scene and display components
+      run: |
+        ls -la ${{ github.workspace }}/components/firefly-display
+        ls -la ${{ github.workspace }}/components/firefly-scene
+        git submodule status
+    - name: Build pixie-firmware using Docker
+      id: build
+      run: |
+        echo $MAX_MEMORY_SIZE
+        docker run -m $MAX_MEMORY_SIZE --rm -v $PWD:/project -w /project -u $UID -e HOME=/tmp espressif/idf idf.py build
+    - name: Verify assets
+      run: |
+        ls -l ${{ github.workspace }}/build/pixie.bin
+        ls -l ${{ github.workspace }}/build/bootloader/bootloader.bin
+        ls -l ${{ github.workspace }}/build/partition_table/partition-table.bin

.gitmodules

@@ -0,0 +1,8 @@
+[submodule "components/firefly-scene"]
+	path = components/firefly-scene
+	url = https://github.com/firefly/component-scene.git
+	branch = main
+[submodule "components/firefly-display"]
+	path = components/firefly-display
+	url = https://github.com/firefly/component-display.git
+	branch = main

README.md

@@ -10,6 +10,30 @@ but has many of the necessary API to implement a hardware wallet.
 - [Device](https://github.com/firefly/pixie-device) Design, Schematics and PCB
 - [Case](https://github.com/firefly/pixie-case)
 
+Development
+-----------
+
+To get this project and it's submodules:
+```sh
+git clone --recurse-submodules https://github.com/firefly/pixie-firmware.git
+```
+
+If you already cloned the project and forgot `--recurse-submodules`
+```sh
+git submodule update --init --recursive
+```
+
+To get upstream changes from the remote submodules
+```sh
+git pull --recurse-submodules
+```
+
+Use [docker](https://docs.docker.com/engine/install) to build the project:
+```sh
+docker run --rm -v $PWD:/project -w /project -e HOME=/tmp espressif/idf idf.py build
+```
+
+
 
 Hardware Specifications
 -----------------------