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

Tweaks docs to point at Arribada #6

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Tweaks docs to point at Arribada #6

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Notecard C Zephyr Module

This repo is a [Zephyr](https://zephyrproject.org/) module required for pulling and building the [note-c](https://github.com/blues/note-c) library to control the [blues.io](https://blues.io) Notecard. Currently the submodule for `note-c` is pinned to the `master` branch.
This repo is a [Zephyr](https://zephyrproject.org/) module required for pulling and building the [note-c](https://github.com/blues/note-c) library to control the [blues.io](https://blues.io) Notecard. Currently the submodule for `note-c` tracks the `master` branch.

## Usage

Expand All @@ -17,7 +17,7 @@ To use this module, add the following to your Zephyr project's `west.yml` manife
path: modules/notecard
revision: main
submodules: true
url: https://github.com/blues/note-zephyr
url: https://github.com/arribada/notecard-lib-zephyr
```

Then, run `west update` to pull the module into your project.
Expand All @@ -40,7 +40,7 @@ You should ensure the host device you are targetting has this alias defined in i

### Example

Included in this repo is a simple example for using the west module to send a note using the Notecard. See the [example](example/README.md) for more details.
Included in this repo is a simple example for using the `west` module to send a note using the Notecard. See the [example](example/README.md) for more details.

## License

Expand Down