summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn Hodge <tpg@ucc.asn.au>2018-05-05 19:32:09 +0800
committerJohn Hodge <tpg@ucc.asn.au>2018-05-05 19:32:09 +0800
commitba9b4c4da6b9117529370f402e1015bf1730ccb2 (patch)
tree13e01405c875ef18149fdb44e3c0bdd9a3dd38e2 /README.md
parent8747439377381a932b4100fbcd7e7df23e4441e0 (diff)
downloadmrust-ba9b4c4da6b9117529370f402e1015bf1730ccb2.tar.gz
Docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 439bae83..49677984 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,18 @@ Windows
- Run `vsproject/build_rustc_minicargo.cmd` to attempt to build libstd
+Building non-rustc code
+=======================
+
+To build your own code with mrustc, first you need to build at least libcore (and probably the full standard library).
+This can be done on linux by running `make -f minicargo.mk LIBS`, or on windows with `build_std.cmd`.
+
+Next, run
+- `minicargo -L <path_to_libstd> <crate_path>` to build a cargo project.
+- or, `mrustc -L <path_to_libstd> --out-dir <output_directory> <path_to_main.rs>` to directly invoke mrustc.
+
+For additional options, both programs have a `--help` option.
+
Diagnosing Issues and Reporting Bugs
====================================
@@ -77,6 +89,8 @@ Current Features
- Functional cargo clone (minicargo)
- Includes build script support
- Procedural macros (custom derive)
+- Custom target specifications
+ - See `docs/target.md`
Plans
=====