Skip to content

Commit 27cfc4a

Browse files
committed
updated cargo.toml and readme for publishing
1 parent 4bb766b commit 27cfc4a

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ name = "libipt"
33
version = "0.1.0"
44
authors = ["sum_catnip <[email protected]>"]
55
edition = "2018"
6+
license = "MIT"
7+
description = "The Intel Processor Trace (Intel PT) Decoder Library is Intel's reference implementation for decoding Intel PT."
8+
repository = "https://github.com/sum-catnip/libipt-rs"
69

710
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
811

readme.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
1-
# TODO
2-
- double check if ive wrapped all functions
1+
# Libipt
2+
3+
> The Intel Processor Trace (Intel PT) Decoder Library is Intel's reference
4+
implementation for decoding Intel PT. It can be used as a standalone library or
5+
it can be partially or fully integrated into your tool.
6+
7+
This Repository contains high level rust bindings for the complete functionality provided by [the original libipt library](https://github.com/intel/libipt).
8+
9+
# State
10+
11+
## Testing
12+
13+
All of the functionality is implemented and should be working
14+
but the test coverage is not complete.
15+
If there is interest in this library i might add some more testing.
16+
Contributions are also appreciated.
17+
18+
## Documentation
19+
20+
I did my best to provide useful documentation for most of the library.
21+
If you see any missing or weird documentation feel free to open an issue or pull request.
322

423
# Unit Tests
524
- block: ✔️

0 commit comments

Comments
 (0)