Skip to content

Commit 7021fae

Browse files
committed
Add setup instructions and DMFFS module files
- Introduced environment setup instructions in README.md for Docker and native Linux. - Added DMOD Flash File System (DMFFS) implementation with README, LICENSE, and dependency files. - Included scripts for building and managing DMFFS. - Updated submodule reference for dmod.
1 parent 63a0ce3 commit 7021fae

16 files changed

Lines changed: 955 additions & 1 deletion

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,68 @@
22

33
Dynamic Modules (dMOD) bootloader - A minimalistic embedded project for STM32 microcontrollers.
44

5+
## Setting Up Your Environment
6+
7+
### Option 1: Docker (Recommended for Easy Setup)
8+
9+
The easiest way to get started is to use the pre-configured Docker image that includes all necessary tools:
10+
11+
```bash
12+
docker run -it --rm \
13+
-v $(pwd):/workspace \
14+
-w /workspace \
15+
chocotechnologies/dmboot:1.0.0 \
16+
bash
17+
```
18+
19+
This Docker image includes:
20+
- ARM GNU toolchain (arm-none-eabi-gcc)
21+
- CMake
22+
- Renode emulator
23+
- All dMOD tools and libraries
24+
- Python development environment
25+
26+
Once inside the container, you can proceed directly to [Building](#building).
27+
28+
### Option 2: Native Linux Setup
29+
30+
If you prefer to set up your Linux environment natively, we provide an automated setup script that installs all necessary tools and dependencies:
31+
32+
```bash
33+
./scripts/setup-linux-env.sh
34+
```
35+
36+
**What this script does:**
37+
1. Calls the DMOD base environment setup (installs ARM toolchain, CMake, and other core tools)
38+
2. Installs additional dMOD Boot specific packages:
39+
- Renode emulator
40+
- ncurses libraries (with automatic fallback for modern systems)
41+
- GTK libraries (with T64 ABI support)
42+
- Python 3 and pip
43+
- Other development utilities
44+
3. Sets up the environment variables and bash aliases
45+
46+
**Advanced options:**
47+
48+
```bash
49+
# Skip DMOD base setup if you've already set it up separately
50+
./scripts/setup-linux-env.sh --skip-dmod-setup
51+
52+
# Specify custom tool directory
53+
./scripts/setup-linux-env.sh --tools-dir /opt/tools
54+
55+
# Specify custom Renode version
56+
./scripts/setup-linux-env.sh --renode-version 1.14.0
57+
58+
# View all available options
59+
./scripts/setup-linux-env.sh --help
60+
```
61+
62+
After running the script, restart your terminal or run:
63+
```bash
64+
source ~/.bashrc
65+
```
66+
567
## Building
668

769
### Building for Hardware

scripts/dmf/make_dmffs.dmd

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# DMOD Dependencies File
2+
# Generated from module: make_dmffs
3+
# Source file: /__w/dmffs/dmffs/build_x86_64/dmf/make_dmffs.dmf
4+
#
5+
# This file lists all non-system modules required by the module.
6+
# Use with dmf-get: dmf-get -d /__w/dmffs/dmffs/build_x86_64/dmf/make_dmffs.dmd
7+

scripts/dmf/make_dmffs.dmf

6.41 KB
Binary file not shown.

scripts/dmf/make_dmffs/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Choco-Technologies
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)