Skip to content

Commit 4ee63e1

Browse files
committed
Add ci pipeline
1 parent 20b9c88 commit 4ee63e1

File tree

2 files changed

+41
-8
lines changed

2 files changed

+41
-8
lines changed

.github/workflows/ci.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: ci
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Build
15+
run: |
16+
make
17+
- name: Archive
18+
uses: actions/upload-artifact@v4
19+
with:
20+
name: artifacts
21+
path: |
22+
build-artifacts/zephyr.uf2
23+
build-artifacts/zephyr/fprime-zephyr-deployment/dict/ReferenceDeploymentTopologyDictionary.json
24+

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,37 +24,46 @@ make
2424
## Running the code
2525

2626
Run generate from the `proves-core-reference` directory. This generates the build cache for FPrime. You only need to do generate if something in the core FPrime package has changed
27-
```
27+
```shell
2828
make generate
2929
```
3030

3131
Then, and everytime you change code, run
3232

33-
```
33+
```shell
3434
make build
3535
```
3636

37-
Next, plug in your board! You want to find the location of the board on your computer. It should be called something like RP2350 but you want to find the path to it
37+
### Find the path to your board
3838

39-
For Mac:
39+
Next, plug in your board! If you have previously installed a firmware on your board you may not see it show up as a drive. In that case you'll want to find it's `tty` port.
40+
41+
To do this, run the following command
42+
```shell
43+
make list-tty
4044
```
45+
46+
Otherwise, you want to find the location of the board on your computer. It should be called something like RP2350 but you want to find the path to it
47+
48+
For Mac:
49+
```shell
4150
ls -lah /Volumes
4251
```
4352

4453
For Windows:
4554
Check the letter said to be the mount (ex /d/) and then the name of the removable drive (ex /d/RP2350)
4655

4756
For Linux:
48-
```
57+
```shell
4958
findmnt
5059
```
5160

52-
Now you want to copy the code from the deployment we just made. Before you run this command you have to make this board writable by pressing the two buttons in succesion
53-
```
61+
Now you want to install the firmware to the board.
62+
```shell
5463
make install BOARD_DIR=[path-to-your-board]
5564
```
5665

5766
Finally, run the fprime-gds.
58-
```
67+
```shell
5968
make gds
6069
```

0 commit comments

Comments
 (0)