|
1 | 1 | # cmsis-pack-manager |
2 | | -cmsis-pack-manager is a python module, Rust crate and command line utility for managing current device information that is stored in many CMSIS PACKs. Users of cmsis-pack-manager may query for information such as processor type, flash algorithm and memory layout information in a python program or through the command line utility, `pack-manager`, provided as part of this module. |
3 | 2 |
|
4 | | -# CI Status |
5 | | -[](https://ci.appveyor.com/project/theotherjimmy/cmsis-pack-manager) [](https://travis-ci.org/ARMmbed/cmsis-pack-manager) |
| 3 | +[](https://pypi.python.org/pypi/cmsis-pack-manager) |
| 4 | +[](https://github.com/pyocd/cmsis-pack-manager/actions) |
6 | 5 |
|
7 | | -## Wheels |
8 | | - |
9 | | -The last step of CI uploads binary wheels to [this S3 bucket.](http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/cmsis-pack-manager/dist/) |
| 6 | +`cmsis-pack-manager` is a python module, Rust crate and command line utility |
| 7 | +for managing current device information that is stored in many CMSIS PACKs. |
| 8 | +Users of `cmsis-pack-manager `may query for information such as processor |
| 9 | +type, flash algorithm and memory layout information in a python program or |
| 10 | +through the command line utility, `pack-manager`, provided as part of this |
| 11 | +module. |
10 | 12 |
|
11 | 13 | # DOCS! |
12 | 14 |
|
13 | 15 | They live here: https://pyocd.github.io/cmsis-pack-manager/ |
14 | 16 |
|
15 | 17 | # Building |
16 | 18 |
|
17 | | -To build cmsis-pack-manager locally, Install a stable rust compiler. |
18 | | -See https://rustup.rs/ for details on installing `rustup`, the rust |
19 | | -toolchain updater. Afterwards, run `rustup update stable` to get the |
20 | | -most recent stable rust toolchain and build system. |
| 19 | +To build `cmsis-pack-manager` locally, Install a stable rust compiler. See |
| 20 | +https://rustup.rs/ for details on installing `rustup`, the Rust toolchain |
| 21 | +updater. Afterwards, run `rustup toolchain install` to get the Rust toolchain |
| 22 | +and build system for building `cmsis-pack-manager`. |
21 | 23 |
|
22 | | -After installing the rust toolchain and downloading a stable compiler, |
23 | | -run `python2 setup.py bdist_wheel` from the root of this repo to |
24 | | -generate a binary wheel (`.whl` file) in the same way as we release. |
| 24 | +After installing the rust toolchain and downloading a stable compiler, run |
| 25 | +`pip wheel .` from the root of this repo to generate a binary wheel (`.whl` |
| 26 | +file). Alternatively you can run `pip install maturin cffi` and then |
| 27 | +`maturin build` for a process closer to the way we build releases. |
25 | 28 |
|
26 | 29 | For testing purposes, there is a CLI written in Rust within the rust |
27 | 30 | workspace as the package `cmsis-cli`. For example From the `rust` |
|
0 commit comments