瀏覽代碼

Add instructions for usage

ticki 9 年之前
父節點
當前提交
7f66ee45a0
共有 1 個文件被更改,包括 17 次插入0 次删除
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -2,6 +2,23 @@
 
 Redox's fast & memory efficient userspace allocator.
 
+## Using ralloc
+
+Add ralloc to `Cargo.toml`:
+
+```toml
+[dependencies.ralloc]
+git = "https://github.com/redox-os/ralloc.git"
+```
+
+then import it in your main file:
+
+```rust
+extern crate ralloc;
+```
+
+`ralloc` is now ready to roll!
+
 ## Features
 
 ### Custom out-of-memory handlers