summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn Hodge <tpg@mutabah.net>2018-05-11 08:02:00 +0800
committerJohn Hodge <tpg@mutabah.net>2018-05-11 08:02:00 +0800
commit174c4f47160dba499c84986d15180fe4307d4adc (patch)
tree9d4f154d404efed09c54e27041eaaa9852773e3b /README.md
parent3b8d8f1a392a2cb5cad1d57d08ced693a0d197d8 (diff)
parentba9b4c4da6b9117529370f402e1015bf1730ccb2 (diff)
downloadmrust-174c4f47160dba499c84986d15180fe4307d4adc.tar.gz
Merge branch 'master' of https://github.com/thepowersgang/mrustc
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
=====