From 6165bf6e4cfde199c3bc8bd0b862eb7de309aec3 Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Mon, 23 Apr 2018 16:36:26 +0200 Subject: add a bit more documentation --- src/lib.rs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'src/lib.rs') diff --git a/src/lib.rs b/src/lib.rs index 0876ea3..3e1aeee 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,21 @@ //! `evtclib` is a crate aiming to provide utility functions to parse and work //! with `.evtc` reports generated by arcdps. +//! +//! # Workflow +//! +//! ```no_run +//! # use std::fs::File; +//! // Open some file for processing +//! let mut file = File::open("my_log.evtc").unwrap(); +//! // Parse the raw content of the file +//! let raw_log = evtclib::raw::parse_file(&mut file).unwrap(); +//! // Process the file to do the nitty-gritty low-level stuff done +//! let log = evtclib::process(&raw_log).unwrap(); +//! // Do work on the log +//! ``` +//! +//! (Look at the note on "Buffering" in the [parser +//! module](raw/parser/index.html#buffering)) #![feature(try_trait)] #[macro_use] extern crate quick_error; -- cgit v1.2.3