Skip to content

Commit bda22b2

Browse files
ckrenslehnerckrenslehner
committed
docs: adjust readme
1 parent 9e47cdd commit bda22b2

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ These parts are represented by the following crates:
55
- `stm32cubeprogrammer`: Safe rust interface around the sys crate
66
- `stm32cubeprogrammer-cli`: Command line interface which uses `stm32cubeprogrammer` as a library
77

8-
## Preequisites
9-
There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using version 2.18.0.
8+
## Requirements
9+
There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
1010

1111
## Platform support
1212
Windows and Linux are both supported.

‎stm32cubeprogrammer-cli/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# stm32cubeprogrammer-cli
22

33
This CLI aims to provide a simple interface for setting up stm32 targets.
4-
Supported commands:
4+
## Supported commands
55
- Flashing bin and hex files
66
- Updating BLE stack
77
- Resetting target
@@ -14,7 +14,7 @@ All commands above can be combined in a single command line invocation by chaini
1414

1515
If you need other commands, feel free to open an issue or a pull request. :smile:
1616

17-
### Example usage:
17+
## Example usage:
1818
Where `installation_dir` is the path to the root directory of the STM32CubeProgrammer installation.
1919
E.g. `C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer`
2020

@@ -40,14 +40,13 @@ Use `--help` to see all available options.
4040
```sh
4141
stm32cubeprogrammer-cli --help
4242
```
43-
### Requirements
44-
- STM32CubeProgrammer installed on your system
45-
- A connected ST-Link probe with a target
43+
## Requirements
44+
There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
4645

47-
### Platform support
46+
## Platform support
4847
Windows and Linux are supported and tested.
4948

50-
### Warranty
49+
## Warranty
5150
This crate is supplied as is without any warranty. Use at your own risk.
5251

5352
License: MIT

‎stm32cubeprogrammer-cli/src/main.rs

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! This CLI aims to provide a simple interface for setting up stm32 targets.
2-
//! Supported commands:
2+
//! # Supported commands
33
//! - Flashing bin and hex files
44
//! - Updating BLE stack
55
//! - Resetting target
@@ -12,7 +12,7 @@
1212
//!
1313
//! If you need other commands, feel free to open an issue or a pull request. :smile:
1414
//!
15-
//! ## Example usage:
15+
//! # Example usage:
1616
//! Where `installation_dir` is the path to the root directory of the STM32CubeProgrammer installation.
1717
//! E.g. `C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer`
1818
//!
@@ -38,14 +38,13 @@
3838
//! ```sh
3939
//! stm32cubeprogrammer-cli --help
4040
//! ```
41-
//! ## Requirements
42-
//! - STM32CubeProgrammer installed on your system
43-
//! - A connected ST-Link probe with a target
41+
//! # Requirements
42+
//! There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
4443
//!
45-
//! ## Platform support
44+
//! # Platform support
4645
//! Windows and Linux are supported and tested.
47-
//!
48-
//! ## Warranty
46+
//!
47+
//! # Warranty
4948
//! This crate is supplied as is without any warranty. Use at your own risk.
5049
5150
mod display_handler;

‎stm32cubeprogrammer/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This crate provides a high-level rust API for the STM32CubeProgrammer DLL.
44

5-
Example usage:
5+
## Example usage:
66
```rust
77
use stm32cubeprogrammer::{
88
probe::{ConnectionParameters, Protocol, ResetMode},
@@ -52,8 +52,9 @@ let connected = programmer
5252

5353
println!("FUS information: {}", connected.fus_info());
5454
```
55+
More examples can be found in the `tests` directory.
5556

56-
### Supported features:
57+
## Supported features:
5758
- Downloading files as hex or bin
5859
- Reading and writing memory
5960
- Uses the [`bytemuck::Pod`](https://docs.rs/bytemuck/1.21.0/bytemuck/trait.Pod.html) trait for reading and writing data from/to memory
@@ -66,25 +67,25 @@ println!("FUS information: {}", connected.fus_info());
6667

6768
If there is a feature missing, feel free to open an issue or a pull request. :smile:
6869

69-
### Examples
70-
You can find more examples in the `tests` directory. An example for using the library as part of a project is the [`stm32cubeprogrammer-cli`]
71-
72-
### Running the tests
70+
## Running the tests
7371
The tests require a STM32CubeProgrammer installation on the host machine and a connected st-link probe with a target.
7472
To run the tests add a `.env` which at least contains the path to the STM32CubeProgrammer installation directory:
7573
```env
7674
STM32_CUBE_PROGRAMMER_DIR="C:\\Program Files\\STMicroelectronics\\STM32Cube\\STM32CubeProgrammer"
7775
```
7876
A list of the expected environment variables can be found in the `test_common.rs` file.
7977

80-
### Other crates similar to this one
78+
## Other crates similar to this one
8179
When I was looking for a rust API for the STM32CubeProgrammer DLL, I found [this](https://github.com/wervin/stm32cubeprog-rs) crate.
8280
Playing around with it, I got interested in the topic and decided to try writing my own version. :rocket:
8381

84-
### Platform support
82+
## Requirements
83+
There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
84+
85+
## Platform support
8586
Windows and Linux are supported and tested.
8687

87-
### Warranty
88+
## Warranty
8889
This crate is supplied as is without any warranty. Use at your own risk.
8990

9091
License: MIT

‎stm32cubeprogrammer/src/lib.rs

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! This crate provides a high-level rust API for the STM32CubeProgrammer DLL.
22
//!
3-
//! Example usage:
3+
//! # Example usage:
44
//! ```no_run
55
//! use stm32cubeprogrammer::{
66
//! probe::{ConnectionParameters, Protocol, ResetMode},
@@ -50,8 +50,9 @@
5050
//!
5151
//! println!("FUS information: {}", connected.fus_info());
5252
//! ```
53+
//! More examples can be found in the `tests` directory.
5354
//!
54-
//! ## Supported features:
55+
//! # Supported features:
5556
//! - Downloading files as hex or bin
5657
//! - Reading and writing memory
5758
//! - Uses the [`bytemuck::Pod`](https://docs.rs/bytemuck/1.21.0/bytemuck/trait.Pod.html) trait for reading and writing data from/to memory
@@ -64,25 +65,25 @@
6465
//!
6566
//! If there is a feature missing, feel free to open an issue or a pull request. :smile:
6667
//!
67-
//! ## Examples
68-
//! You can find more examples in the `tests` directory. An example for using the library as part of a project is the [`stm32cubeprogrammer-cli`]
69-
//!
70-
//! ## Running the tests
68+
//! # Running the tests
7169
//! The tests require a STM32CubeProgrammer installation on the host machine and a connected st-link probe with a target.
7270
//! To run the tests add a `.env` which at least contains the path to the STM32CubeProgrammer installation directory:
7371
//! ```env
7472
//! STM32_CUBE_PROGRAMMER_DIR="C:\\Program Files\\STMicroelectronics\\STM32Cube\\STM32CubeProgrammer"
7573
//! ```
7674
//! A list of the expected environment variables can be found in the `test_common.rs` file.
7775
//!
78-
//! ## Other crates similar to this one
76+
//! # Other crates similar to this one
7977
//! When I was looking for a rust API for the STM32CubeProgrammer DLL, I found [this](https://github.com/wervin/stm32cubeprog-rs) crate.
8078
//! Playing around with it, I got interested in the topic and decided to try writing my own version. :rocket:
81-
//!
82-
//! ## Platform support
79+
//!
80+
//! # Requirements
81+
//! There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
82+
//!
83+
//! # Platform support
8384
//! Windows and Linux are supported and tested.
84-
//!
85-
//! ## Warranty
85+
//!
86+
//! # Warranty
8687
//! This crate is supplied as is without any warranty. Use at your own risk.
8788
8889
pub mod api_log;

0 commit comments

Comments
 (0)