Skip to content

Commit 154d87c

Browse files
committed
update README with reference to cli project
1 parent 2234d03 commit 154d87c

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# API
22

3-
![Build](https://github.com/StratifyLabs/API/workflows/Build/badge.svg)
4-
53
## Overview
64

75
API is a collection of cross-platform C++ libraries for
@@ -21,6 +19,13 @@ including
2119
- [ThreadAPI](libraries/ThreadAPI): thread management
2220
- [VarAPI](libraries/VarAPI): data and strings
2321

22+
## How to Build
23+
24+
The `API` library is designed to be a CMake sub-project. To build, please use one of these projects:
25+
26+
- Desktop [Command Line Interface](https://github.com/StratifyLabs/cli)
27+
- [Stratify OS on Nucleo-144](https://github.com/StratifyLabs/StratifyOS-Nucleo144)
28+
2429
## Design
2530

2631
The API framework is a hard to mis-use, non-onerous C++ API achieved using the following principles:

0 commit comments

Comments
 (0)