From 4cd374e1a71a8551e65ba8bf906fd6754457be30 Mon Sep 17 00:00:00 2001 From: ruby0x1 Date: Tue, 6 Apr 2021 19:59:42 -0700 Subject: [PATCH] fix amalgamation documentation --- doc/site/getting-started.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/site/getting-started.markdown b/doc/site/getting-started.markdown index 742de0e2..e0362dc1 100644 --- a/doc/site/getting-started.markdown +++ b/doc/site/getting-started.markdown @@ -59,7 +59,9 @@ Since it has no dependencies this is simple, all the code in `src/` comes along. If you want an even simpler way, there's an 'amalgamated' build (often called `blob`, or `unity` builds.). This is _all of the wren source code in one file_. -This file can be generated by running `python3 util/generate_amalgamation.py`, and the generated output will be in `build/wren.c`. +This file can be generated by running `python3 util/generate_amalgamation.py > build/wren.c`, +which saves the generated output in `build/wren.c`. + Include `build/wren.c` and `src/include/wren.h` in your project code and you're good to go. Ideally later we can automate generating this and include it in the repo.