Skip to content

Commit

Permalink
finalize README
Browse files Browse the repository at this point in the history
  • Loading branch information
tmplt committed Jan 5, 2022
1 parent 81078ea commit 9dc02e2
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# `cargo-rtic-scope` - single-click solution for tracing [RTIC](https://rtic.rs) applications running on embedded ARM Cortex-M targets.
See https://rtic-scope.github.io for documentation.
# RTIC Scope

# `cortex-m-rtic-trace` - target-side crate for RTIC Scope tracing functionality
`cortex-m-rtic-trace` is an auxiliary crate for ARM Cortex-M platforms to correctly enable tracing of [RTIC](https://rtic.rs) applications via the ITM/DWT subsystems. A set of intialization functions are exposed that are expected to be called at the end of `#[init]`. These will ensure that tracing peripherals are configured as expected. Additionally, a `#[trace]` macro is exposed that enable tracing of RTIC software tasks.
> RTIC Scope is an non-intrusive auxillary toolset for tracing [RTIC](https://rtic.rs) programs executing on ARMv7-M targets by exploiting the *Instrumentation Trace Macrocell* (ITM) and *Data Watchpoint and Trace* (DWT) units.
## Examples
Refer to [rtic-scope/examples](https://github.com/rtic-scope/examples) for example uses of `rtic-scope` in combination with the remainder of the RTIC Scope framework.
## [Documentation](https://github.com/rtic-scope)

## License
For non-commercial purposes, the code in this repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
See [LICENSE-APACHE](cargo-rtic-scope/LICENSE-APACHE) and [LICENSE-MIT](cargo-rtic-scope/LICENSE-MIT) for details.

This project is maintained in cooperation with @GrepitAB and Luleå Technical University.
This project is maintained in cooperation with [@GrepitAB](https://github.com/GrepitAB) and Luleå Technical University.
For commercial support and alternative licensing, inquire via <[email protected]>.

0 comments on commit 9dc02e2

Please sign in to comment.