mirror of
https://codeberg.org/demostf/parser.git
synced 2026-06-03 10:14:06 +02:00
a basic readme
This commit is contained in:
parent
8a428dc6ed
commit
5a9480da45
1 changed files with 20 additions and 0 deletions
20
README.md
Normal file
20
README.md
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
# TF Demo Parser
|
||||||
|
|
||||||
|
Parsing of tf2 demo files
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
This project is build using rust and requires `cargo` and friends, see [the rust website](https://www.rust-lang.org/)
|
||||||
|
for how to get started.
|
||||||
|
|
||||||
|
Once rust is setup building is as simple as
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo build --release
|
||||||
|
```
|
||||||
|
|
||||||
|
which will place the binary at `target/release/parse_demo`
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Basic usage is as simple as `parse_demo demofile.dem` which will output a "summary" of the demo file in JSON format.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue