From 8a59808b24a728a7034bd697206c4921211569ba Mon Sep 17 00:00:00 2001
From: bjorn3 <bjorn3@users.noreply.github.com>
Date: Wed, 23 Sep 2020 16:44:02 +0200
Subject: [PATCH] Improve readme

---
 Readme.md        | 18 ++----------------
 docs/env_vars.md | 17 +++++++++++++++++
 2 files changed, 19 insertions(+), 16 deletions(-)
 create mode 100644 docs/env_vars.md

diff --git a/Readme.md b/Readme.md
index f5a38f0843b..c4e55975541 100644
--- a/Readme.md
+++ b/Readme.md
@@ -2,7 +2,7 @@
 
 > ⚠⚠⚠ Certain kinds of FFI don't work yet. ⚠⚠⚠
 
-The goal of this project is to create an alternative codegen backend for the rust compiler based on [Cranelift](https://github.com/bytecodealliance/wasmtime/blob/master/cranelift). This has the potential to improve compilation times in debug mode. If your project doesn't use any of the things listed under "Not yet supported", it should probably work fine. If not please open an issue.
+The goal of this project is to create an alternative codegen backend for the rust compiler based on [Cranelift](https://github.com/bytecodealliance/wasmtime/blob/master/cranelift). This has the potential to improve compilation times in debug mode. If your project doesn't use any of the things listed under "Not yet supported", it should work fine. If not please open an issue.
 
 ## Building
 
@@ -59,21 +59,7 @@ function jit_calc() {
 
 ## Env vars
 
-<dl>
-    <dt>CG_CLIF_JIT</dt>
-    <dd>Enable JIT mode to immediately run a program instead of writing an executable file.</dd>
-    <dt>CG_CLIF_JIT_ARGS</dt>
-    <dd>When JIT mode is enable pass these arguments to the program.</dd>
-    <dt>CG_CLIF_INCR_CACHE_DISABLED</dt>
-    <dd>Don't cache object files in the incremental cache. Useful during development of cg_clif
-    to make it possible to use incremental mode for all analyses performed by rustc without caching
-    object files when their content should have been changed by a change to cg_clif.</dd>
-    <dt>CG_CLIF_DISPLAY_CG_TIME</dt>
-    <dd>If "1", display the time it took to perform codegen for a crate</dd>
-    <dt>CG_CLIF_FUNCTION_SECTIONS</dt>
-    <dd>Use a single section for each function. This will often reduce the executable size at the
-        cost of making linking significantly slower.</dd>
-</dl>
+[see env_vars.md](docs/env_vars.md)
 
 ## Not yet supported
 
diff --git a/docs/env_vars.md b/docs/env_vars.md
new file mode 100644
index 00000000000..3707909a978
--- /dev/null
+++ b/docs/env_vars.md
@@ -0,0 +1,17 @@
+# List of env vars recognized by cg_clif
+
+<dl>
+    <dt>CG_CLIF_JIT</dt>
+    <dd>Enable JIT mode to immediately run a program instead of writing an executable file.</dd>
+    <dt>CG_CLIF_JIT_ARGS</dt>
+    <dd>When JIT mode is enable pass these arguments to the program.</dd>
+    <dt>CG_CLIF_INCR_CACHE_DISABLED</dt>
+    <dd>Don't cache object files in the incremental cache. Useful during development of cg_clif
+    to make it possible to use incremental mode for all analyses performed by rustc without caching
+    object files when their content should have been changed by a change to cg_clif.</dd>
+    <dt>CG_CLIF_DISPLAY_CG_TIME</dt>
+    <dd>If "1", display the time it took to perform codegen for a crate</dd>
+    <dt>CG_CLIF_FUNCTION_SECTIONS</dt>
+    <dd>Use a single section for each function. This will often reduce the executable size at the
+        cost of making linking significantly slower.</dd>
+</dl>