aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 5bb03ff3bbb901aad9377f782f65a92d02de6511 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
includedir
===========

[![Build Status](https://img.shields.io/travis/tilpner/includedir.svg?style=flat-square)](https://travis-ci.org/tilpner/includedir)
[![Crates.io version](https://img.shields.io/crates/v/includedir.svg?style=flat-square)](https://crates.io/crates/includedir)
[![Crates.io license](https://img.shields.io/crates/l/includedir.svg?style=flat-square)](https://crates.io/crates/includedir)

Include a directory in your Rust binary, e.g. static files for your web server or assets for your game.

## Example

**Cargo.toml**
```toml
[package]
name = "example"
version = "0.1.0"

build = "build.rs"
include = ["data"]

[dependencies]
phf = "0.7.12"

[build-dependencies]
includedir = "0.1.1"
```

**build.rs**

```rust
extern crate includedir;

fn main() {
    includedir::build("data").unwrap();
}
```

**src/main.rs**

```rust
extern crate phf;

include!(concat!(env!("OUT_DIR"), "/dir_data.rs"));

fn main() {
    for (k, v) in FILES.entries() {
        println!("{}: {} bytes", k, v.len());
    }
}
```