Leahnaya/kbinxml-rs
1
0
Fork 0
mirror of https://github.com/mbilker/kbinxml-rs.git synced 2026-09-07 18:15:22 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README with some instructions

Browse Source
This commit is contained in:
Matt Bilker
2018-06-07 03:51:29 +00:00
parent b2a316cf4c
commit 995193dd75
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,7 +1,13 @@
# kbinxml
# kbinxml-rs
An encoder/decoder for Konami's binary XML format, used in some of their games.
**WARNING!** Requires Rust Nightly due to the use of the `int_to_from_bytes` unstable feature.
### Setup
- Setup Rust Nightly through `rustup` or your own preferred method of acquiring the nightly version of Rust
- For using `kbinxml-rs` as a library, add it as a dependency in your `Cargo.toml` file
- For using `kbinxml-rs` as a standalone application, install `kbinxml-rs` using `cargo install kbinxml` (Note: This will not work at the moment as `kbinxml-rs` has not yet been published to [crates.io](https://crates.io))
To be written.