Skip to content

Commit a6a71da

Browse files
authored
[skip ci] Revise README for building demos and library package
Updated instructions for building demos and library package installation.
1 parent 232c8d1 commit a6a71da

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,48 +19,50 @@ Checkout the
1919
[🚀 Getting Started](https://libhal.github.io/getting_started/)
2020
instructions.
2121

22-
## 🏗️ Building Demos
22+
## 📦 Building & installing the Library Package
2323

24-
To build demos, start at the root of the repo and execute the following command:
24+
To build and install the package, start at the root of the repo and execute the
25+
following command:
2526

2627
```bash
27-
conan build demos -pr lpc4078 -pr arm-gcc-12.3
28+
conan create . -pr hal/tc/llvm -pr hal/mcu/stm32f103c8
2829
```
2930

30-
or for the `lpc4074`
31+
To compile the package for the `lpc4078`, simply replace the `stm32f103c8`
32+
profile with the appropriate profile name. For example:
3133

3234
```bash
33-
conan build demos -pr lpc4074 -pr arm-gcc-12.3
35+
conan create . -pr hal/tc/llvm -pr hal/mcu/lpc4078
3436
```
3537

36-
or for the `stm32f103c8`
38+
To build for you local machine, simply supply the OS
3739

3840
```bash
39-
conan build demos -pr stm32f103c8 -pr arm-gcc-12.3
41+
conan create . -pr hal/tc/llvm -pr hal/os/mac
42+
conan create . -pr hal/tc/llvm -pr hal/os/linux
43+
conan create . -pr hal/tc/llvm -pr hal/os/windows
4044
```
4145

42-
## 📦 Building & installing the Library Package
46+
## 🏗️ Building Demos
4347

44-
To build and install the package, start at the root of the repo and execute the
45-
following command:
48+
In order to build the demos you must have created `latest` version of the
49+
package. If you haven't done so, see:
50+
[📦 Building & installing the Library Package](#-building--installing-the-library-package).
51+
52+
To build demos, start at the root of the repo and execute the following command:
4653

4754
```bash
48-
conan create . -pr lpc4078 -pr arm-gcc-12.3 --version=latest
55+
conan build demos -pr hal/tc/llvm -pr hal/mcu/stm32f103c8
4956
```
5057

51-
To compile the package for the `stm32f103c8` or `lpc4074`, simply replace the
52-
`lpc4078` profile with the appropriate profile name. For example:
58+
Replace `hal/mcu/stm32f103c8` with:
5359

54-
```bash
55-
conan create . -pr stm32f103c8 -pr arm-gcc-12.3 --version=latest
56-
```
60+
- `hal/mcu/lcp4078`
61+
- `hal/bare/mod-lpc40-v5`
62+
- `hal/bare/mod-stm32f1-v5`
5763

58-
> [!NOTE]
59-
> If you are developing the code, and simply need to test that the package builds
60-
> and that tests pass, use `conan build .` vs `conan create .`. This will build the
61-
> package locally in the current directory. You'll find the contents in the
62-
> `build/` directory at the root of the repo. Now links will point to the code
63-
> in the repo and NOT the conan package directory.
64+
Demos are only supported by the platforms listed in the `demos/platforms/`
65+
directory.
6466

6567
## 📋 Adding `libhal-expander` to your project
6668

0 commit comments

Comments
 (0)