Skip to content

Commit f41a848

Browse files
committed
Document changes in changelog
Also update readme to refer to capstone-sys readme for supported platforms/requirements.
1 parent 75f1c74 commit f41a848

File tree

2 files changed

+25
-12
lines changed

2 files changed

+25
-12
lines changed

CHANGELOG.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99
### Added
10-
- Architecture-specific detail API
11-
- Detail API unit tests
10+
- Architecture-specific detail API with `InsnDetail::arch_detail()` method
11+
- README badges!
12+
13+
### Change
14+
- `Capstone::disasm()` (and related methods) return empty `Instructions` instead of an error
15+
- Make `Instructions::from_raw_parts()` private
1216

1317
## [0.2.0] - 2017-11-01
1418
### Added
@@ -20,6 +24,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2024
- Partition `Mode` enum into: `Mode`, `ExtraMode`, and `Endian`
2125
- Rename `Capstone` methods that return IDs to include `_ids` in name
2226
- Example: `read_registers()` renamed to `read_register_ids()`
27+
- Minimum Rust version is 1.20.0
28+
29+
### Removed
30+
- `libc` dependency
2331

2432
## [0.1.0] - 2017-09-29
2533
### Added

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,18 @@
88

99
Bindings to the [capstone library][upstream] disassembly framework.
1010

11-
There's an example in `demo.rs`, but as a sample:
11+
12+
# Requirements
13+
14+
`capstone-rs` uses the [`capstone-sys`](https://github.com/capstone-rust/capstone-sys) crate to provide the low-level bindings to the Capstone C library.
15+
16+
See the [`capstone-sys`](https://github.com/capstone-rust/capstone-sys) GitHub page for the requirements and supported platforms.
17+
18+
* Minimum Rust Version: `1.20.0` or later
19+
20+
# Example
21+
22+
The example from [`demo.rs`](examples/demo.rs):
1223

1324
```rust
1425
extern crate capstone;
@@ -111,21 +122,15 @@ Found 5 instructions
111122
insn groups:
112123
```
113124

114-
# Reporting Issues
115-
116-
Please open a [Github issue](https://github.com/capstone-rust/capstone-rs/issues)
117-
118-
# Demo
119-
120-
You can run:
125+
You can the demo by running:
121126

122127
cargo run --example=demo
123128

124129
To produce a short demonstration. More complex demos welcome!
125130

126-
# Minimum Rust Version
131+
# Reporting Issues
127132

128-
`capstone-rs` requires Rust `1.20.0` or later.
133+
Please open a [Github issue](https://github.com/capstone-rust/capstone-rs/issues)
129134

130135
# Author
131136

0 commit comments

Comments
 (0)