Skip to content

Commit 15a6c9e

Browse files
committed
fix stuff
1 parent a08843a commit 15a6c9e

File tree

2 files changed

+45
-32
lines changed

2 files changed

+45
-32
lines changed

Cargo.toml

+8-7
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ license = "MIT OR Apache-2.0"
1010
name = "ergo_std"
1111
readme = "README.md"
1212
repository = "https://github.com/rust-crates/ergo_std"
13-
version = "0.1.0"
13+
version = "0.0.1"
1414

1515
[dependencies]
16-
failure = "0.1.1"
17-
itertools = "0.7.6"
18-
lazy_static = "1.0.0"
19-
maplit = "1.0.1"
20-
ordermap = "0.3.5"
21-
std_prelude = "0.2.11"
16+
itertools = "0.7"
17+
lazy_static = "1.0"
18+
maplit = "1.0"
19+
regex = "0.2.5"
20+
serde = "1.0"
21+
serde_derive = "1.0"
22+
std_prelude = "0.2"

src/lib.rs

+37-25
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,36 @@
66
//!
77
//! # How to Use
88
//!
9+
//! In your `Cargo.toml`
10+
//!
11+
//! ```toml,no_compile
12+
//! [dependencies]
13+
//! ergo_std = "0.1"
14+
//! serde = "1.0"
15+
//! serde_derive = "1.0"
16+
//! ```
17+
//!
18+
//! > You have to put the other crates in your `Cargo.toml` in order for `#[derive(...)]` to work
19+
//! > correctly.
20+
//!
921
//! ```rust
10-
//! #[macro_use] extern crate failure;
11-
//! extern crate serde;
12-
//! #[macro_use] extern crate serde_derive;
1322
//! #[macro_use] extern crate ergo_std;
1423
//! use ergo_std::*;
15-
//! # fn main() {
16-
//! # }
24+
//! fn main() {
25+
//! /* Your code goes here */
26+
//! }
1727
//! ```
1828
//!
19-
//! > _As you notice, this crate does not include `serde` or `failure`. This is due to a bug
20-
//! > which makes it impossible for this crate to rexport their `#[derive(...)]` macros.
21-
//!
2229
//! # Exported Items
2330
//!
2431
//! The following crates and types are exported. See their docs for how to use them.
2532
//!
26-
//! - **[`std_prelude`]**: extends rust's additional prelude with commonly used types. The
33+
//! - **[`std_prelude`]**: extends rust's `std::prelude` with commonly used types. The
2734
//! crate is well documented with justification and usecases for each type.
35+
//! - **[`serde`]**: the defacto serialization library of rust. Also imports `serde_derive`
36+
//! so you can use `#[derive(Serialize, Deserialize)]`.
2837
//! - **[`lazy_static!`]**: the `lazy_static!` macro is the current standard way to create
29-
//! global variables and constants in a majority of crates.
38+
//! global variables and constants. Warning that they are created lazily (at run time)!
3039
//! - **[`itertools`]**: the itertools prelude provides traits that extends rust's already
3140
//! extensive iterator API.
3241
//! - **[`maplit`]**: provides `hashmap!`, `hashset!`, `btreemap!` and `btreeset!` macros to
@@ -44,22 +53,21 @@
4453
//!
4554
//! The crates that are exported are:
4655
//!
47-
//! - [**std_prelude**](https://github.com/vitiral/std_prelude):
48-
//! Multi-producer multi-consumer channels for message passing
49-
//! - [**lazy_static**](TODO): TODO
50-
//! - [**itertools**](TODO): TODO
51-
//! - [**maplit**](TODO): TODO
52-
//! - [**regex**](TODO): TODO
56+
//! - [**serde**](https://github.com/serde-rs/serde): Serialization framework for Rust
57+
//! - [**std_prelude**](https://github.com/vitiral/std_prelude): prelude that the rust stdlib
58+
//! should have always had
59+
//! - [**lazy_static**](https://github.com/rust-lang-nursery/lazy-static.rs): A small macro for
60+
//! defining lazy evaluated static variables in Rust.
61+
//! - [**itertools**](https://github.com/bluss/rust-itertools): Extra iterator adaptors, iterator
62+
//! methods, free functions, and macros.
63+
//! - [**maplit**](https://github.com/bluss/maplit): Rust container / collection literal macros for
64+
//! HashMap, HashSet, BTreeMap, BTreeSet.
65+
//! - [**regex**](https://github.com/rust-lang/regex): An implementation of regular expressions for
66+
//! Rust. This implementation uses finite automata and guarantees linear time matching on all
67+
//! inputs.
5368
//!
5469
//! Consider supporting their development individually and starring them on github.
55-
//!
56-
//! ## Future crates
57-
//!
58-
//! The following crates will be added in the future:
59-
//!
60-
//! - `indexmap`: the current crate is `ordermap`, which is renaming itself
61-
//! `indexmap` and changing what `ordermap` is... it's confusing but it
62-
//! will be comming shortly
70+
#![allow(unused_imports)]
6371

6472
#[macro_use]
6573
pub extern crate itertools;
@@ -69,11 +77,15 @@ pub extern crate lazy_static;
6977
pub extern crate maplit;
7078
pub extern crate std_prelude;
7179
pub extern crate regex;
80+
pub extern crate serde;
81+
#[macro_use]
82+
pub extern crate serde_derive;
7283

7384
pub use std_prelude::*;
74-
pub use itertools::prelude::*;
7585
pub use lazy_static::*;
7686
pub use itertools::Itertools;
7787
pub use maplit::*;
7888
pub use regex::Regex;
89+
pub use serde::*;
90+
pub use serde_derive::*;
7991

0 commit comments

Comments
 (0)