Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust build instructions #2203

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adjust build instructions #2203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 13 additions & 2 deletions doc/buildAndProgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ git clone https://github.com/InfiniTimeOrg/InfiniTime.git
cd InfiniTime
git submodule update --init
mkdir build
cd build
```

### Project generation using CMake
Expand Down Expand Up @@ -65,8 +64,10 @@ DFU files are the files you'll need to install your build of InfiniTime using OT

#### CMake command

ARM_NONE_EABI_TOOLCHAIN_PATH and NRF5_SDK_PATH must be specified (see above):

```
cmake -DARM_NONE_EABI_TOOLCHAIN_PATH=... -DNRF5_SDK_PATH=...
cmake -S "." -B "build" -DCMAKE_BUILD_TYPE=Release -DARM_NONE_EABI_TOOLCHAIN_PATH=... -DNRF5_SDK_PATH=.. -DBUILD_DFU=1 -DBUILD_RESOURCES=1 -DNRF_TARGET=nrf52
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-DNRF_TARGET=nrf52 isn't needed, it's already specified in the cmake file. Release is also the default type, so I don't think that needs to be specified either (it's listed above, and I think people who need debug will know when they need it, you have to be pretty involved at that point)

As for DFU/resources, how about giving two example commands, one which builds neither (as current) and one which builds both, I think that way users can easily get the idea of what the options do

```

### Build the project
Expand All @@ -85,9 +86,19 @@ If you just want to build the project and run it on the Pinetime, using *pinetim
Build:

```
cd build
make -j4 pinetime-app
```

However if you want to flash the firmware OTA using an app like Gadgetbridge, using *pinetime-mcuboot-app* will create the `pinetime-mcuboot-app-dfu-$VERSION.zip` file you want in the `build/src` folder.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great addition. Maybe modify the above L84 to specify "PineTime devkit"? Currently these instructions kind of assume a devkit, whereas I think a lot of people work on sealed now as the bootloader is very stable


Build:

```
cd build
make -j4 pinetime-mcuboot-app
```

List of files generated:
Binary files are generated into the folder `src`:

Expand Down