Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ Best for: nRF52840-DK, nRF52832-DK, or custom nRF52 boards.

### 1. Clone the repository
```bash
git clone https://github.com/anthropic/EoS.git
cd EoS
git clone https://github.com/embeddedos-org/eos.git
cd eos
```

### 2. Build the blink example
```bash
cd eos/examples/blink-gpio
cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=iot
cmake --build build
```
Expand Down Expand Up @@ -96,11 +96,11 @@ Best for: STM32H743-Nucleo, STM32F4-Discovery, or custom STM32 boards.

### 1. Clone and build
```bash
git clone https://github.com/anthropic/EoS.git
cd EoS/eos/examples/blink-gpio
git clone https://github.com/embeddedos-org/eos.git
cd eos/examples/blink-gpio

cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=industrial
cmake --build build
```
Expand Down Expand Up @@ -128,8 +128,8 @@ Build and run on your development machine — no MCU needed.

### 1. Clone and build
```bash
git clone https://github.com/anthropic/EoS.git
cd EoS/eos/examples/blink-gpio
git clone https://github.com/embeddedos-org/eos.git
cd eos/examples/blink-gpio

# Host build uses Linux HAL backend (simulated GPIO via sysfs/printf)
cmake -B build -DEOS_PRODUCT=iot -DEOS_BUILD_TESTS=ON
Expand Down Expand Up @@ -264,7 +264,7 @@ This produces:
### 3. Sign and flash
```bash
# Create signing key (first time only)
cd EoS/eboot/tools
cd eBoot/tools
python3 sign_image.py --generate-key my-key.pem

# Sign firmware
Expand Down
2 changes: 1 addition & 1 deletion docs/book/part1-foundations/ch01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ For cross-compilation to a specific board:

```bash
cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=industrial
cmake --build build
```
Expand Down
4 changes: 2 additions & 2 deletions docs/book/part1-foundations/ch02-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ done
cd eos/examples/blink-gpio

cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=industrial
cmake --build build
```
Expand Down Expand Up @@ -376,7 +376,7 @@ sudo apt install gcc-arm-none-eabi
cd eos/examples/blink-gpio

cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=iot
cmake --build build

Expand Down
2 changes: 1 addition & 1 deletion docs/book/part1-foundations/ch03-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ Toolchains are YAML-based definitions specifying CC, CXX, AR, sysroot, and flags
Usage:

```bash
cmake -B build -DCMAKE_TOOLCHAIN_FILE=toolchains/arm-none-eabi.cmake
cmake -B build -DCMAKE_TOOLCHAIN_FILE=toolchains/arm-cortex-m4.cmake
`

## 3.9 Configuration Schema Summary
Expand Down
2 changes: 1 addition & 1 deletion docs/book/part4-ecosystem/ch17-eboot.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ cd build && ctest

```bash
cmake -B build-arm -DEBLDR_BOARD=stm32f4 \
-DCMAKE_TOOLCHAIN_FILE=toolchains/arm-none-eabi.cmake
-DCMAKE_TOOLCHAIN_FILE=toolchains/arm-cortex-m4.cmake
cmake --build build-arm
```

Expand Down
2 changes: 1 addition & 1 deletion docs/book/part5-hardware/ch25-ehealth365.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Both devices run EoS firmware with the `wearable` product profile:

```bash
cmake -B build -DEOS_PRODUCT=wearable \
-DCMAKE_TOOLCHAIN_FILE=toolchains/arm-none-eabi.cmake
-DCMAKE_TOOLCHAIN_FILE=toolchains/arm-cortex-m4.cmake
```

The firmware leverages:
Expand Down
4 changes: 2 additions & 2 deletions docs/integration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Build your eos app with the linker script:
```bash
cd EoS/eos
cmake -B build -DEOS_PRODUCT=iot \
-DCMAKE_TOOLCHAIN_FILE=toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=toolchains/arm-cortex-m4.cmake \
-DEOS_LINKER_SCRIPT=../ebuild/_generated/eboot_linker.ld
cmake --build build
```
Expand All @@ -135,7 +135,7 @@ cmake --build build

```bash
# Generate signing key (first time only)
cd EoS/eboot/tools
cd eBoot/tools
python3 sign_image.py --generate-key firmware-key.pem

# Sign the firmware
Expand Down
10 changes: 5 additions & 5 deletions docs/quickstart-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ winget install CMake.CMake
## Step 1: Build an example

```bash
git clone https://github.com/anthropic/EoS.git
cd EoS/eos/examples/blink-gpio
git clone https://github.com/embeddedos-org/eos.git
cd eos/examples/blink-gpio

cmake -B build -DEOS_PRODUCT=iot
cmake --build build
Expand All @@ -58,7 +58,7 @@ Press `Ctrl+C` to stop.
## Step 3: Run the full test suite

```bash
cd EoS/eos
cd eos
cmake -B build -DEOS_BUILD_TESTS=ON
cmake --build build
ctest --test-dir build --output-on-failure
Expand All @@ -69,7 +69,7 @@ ctest --test-dir build --output-on-failure
## Try all examples

```bash
cd EoS/eos/examples
cd eos/examples

# Each example builds the same way:
for example in blink-gpio uart-echo multitask-rtos posix-app multicore-amp; do
Expand Down Expand Up @@ -97,7 +97,7 @@ done
When you're ready to target an MCU:

1. Install the cross-compiler (`arm-none-eabi-gcc`)
2. Add `-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake` to your cmake command
2. Add `-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake` to your cmake command
3. Flash the resulting binary to your board

Your application code stays the same — only the build command changes.
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart-nrf52.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ nrfjprog --version # Should print 10.x or later
## Step 1: Clone and build

```bash
git clone https://github.com/anthropic/EoS.git
cd EoS/eos/examples/blink-gpio
git clone https://github.com/embeddedos-org/eos.git
cd eos/examples/blink-gpio

cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=iot
cmake --build build
```
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart-rpi4.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ sudo apt install cmake gcc g++ git python3 python3-pip

```bash
# On the Raspberry Pi:
git clone https://github.com/anthropic/EoS.git
cd EoS/eos/examples/blink-gpio
git clone https://github.com/embeddedos-org/eos.git
cd eos/examples/blink-gpio

# Build using the Linux HAL backend (native compile on Pi)
cmake -B build -DEOS_PRODUCT=gateway
Expand Down Expand Up @@ -69,7 +69,7 @@ Connect an LED + resistor (330Ω) between GPIO 18 and GND, then run.
sudo apt install gcc-aarch64-linux-gnu

# Build
cd EoS/eos/examples/blink-gpio
cd eos/examples/blink-gpio
cmake -B build \
-DCMAKE_C_COMPILER=aarch64-linux-gnu-gcc \
-DEOS_PRODUCT=gateway
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart-stm32.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ brew install openocd # macOS
## Step 1: Clone and build

```bash
git clone https://github.com/anthropic/EoS.git
cd EoS/eos/examples/blink-gpio
git clone https://github.com/embeddedos-org/eos.git
cd eos/examples/blink-gpio

cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=industrial
cmake --build build
```
Expand Down
2 changes: 1 addition & 1 deletion docs/three-way-alignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ cmake --build build
# Outputs: libeboot_hal.a, libeboot_core.a, ebldr_stage0.bin, eboot_firmware.bin

# Step 5: Sign and flash (uses eboot tools)
cd EoS/eboot/tools
cd eBoot/tools
python3 sign_image.py --key key.pem --input ../../eos/build/app.bin --output signed.bin
```

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/stm32-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ sudo udevadm trigger
## Step 1 — Clone the Repository

```bash
git clone https://github.com/anthropic/EoS.git
cd EoS/eos
git clone https://github.com/embeddedos-org/eos.git
cd eos
```

---
Expand Down
2 changes: 1 addition & 1 deletion examples/ble-sensor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A complete IoT sensor node that reads temperature from an I2C sensor, computes a
```bash
# Cross-compile for nRF52
cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=iot
cmake --build build

Expand Down
2 changes: 1 addition & 1 deletion examples/blink-gpio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ cmake --build build

# ARM cross-compile
cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=iot
cmake --build build
```
Expand Down
2 changes: 1 addition & 1 deletion examples/ui-touchscreen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ A complete touchscreen application that builds an interactive interface with LVG
```bash
# Cross-compile for ARM target
cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-none-eabi.cmake \
-DCMAKE_TOOLCHAIN_FILE=../../toolchains/arm-cortex-m4.cmake \
-DEOS_PRODUCT=hmi
cmake --build build

Expand Down
Loading