Skip to content

Commit ac30452

Browse files
committed
doc: Improve documentation in README.md
1 parent c139e37 commit ac30452

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ default = ["std"]
1515
std = []
1616
# If you does not use std then you need alloc feature
1717
alloc = []
18-
# Allow to use some functions for FFI C types
18+
# Allow to use some FFI for C types
1919
c-types = ["std"]
2020
# Check pointers before to use it to panic if it is null
2121
panic-if-null = []

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Generic functions to work with opaque pointers when use FFI to expose Rust struc
88

99
## Basic usage
1010

11-
With this crate you can manage raw pointers easily to expose structs that will be
11+
With this crate you can manage raw pointers easily to expose `structs` that will be
1212
use as opaque pointers from C or C++ calling to Rust functions to use it. This
1313
can be used with [cbindgen](https://crates.io/crates/cbindgen) crate with option `parse.parse_deps = true`
14-
for it will generate opaque C/C++ structs to use pointers in the arguments.
14+
for it will generate opaque C/C++ `structs` to use pointers in the arguments.
1515

1616
You can find more information about using Rust from other languages in
1717
[The Rust FFI Omnibus objects section](http://jakegoulding.com/rust-ffi-omnibus/objects/)
@@ -62,10 +62,10 @@ with that code, please, [open a issue](https://github.com/jhg/opaque-pointer-rs/
6262

6363
## Features
6464

65-
- `std`: activated by default, it is required for functions using std
66-
- `alloc`: alternative to compile without std but some functions will not be available
67-
- `c-types`: it allow to use C types (like pointers to C strings) and requires std feature
68-
- `panic-if-null`: it will check if a pointer is null to panic before to use a null pointer
65+
- `std`: activated by default, it is required for c-types FFI.
66+
- `alloc`: required if compile without std.
67+
- `c-types`: FFI for C types, requires std feature.
68+
- `panic-if-null`: it will check if a pointer is null to panic before to use it.
6969

7070
## Panic & unwind in FFI functions
7171

0 commit comments

Comments
 (0)