From 76eb4204be8ac073f69d3f3a3361502e09e33775 Mon Sep 17 00:00:00 2001 From: Riyyi Date: Mon, 17 Apr 2023 16:02:04 +0200 Subject: [PATCH] Meta: Update README.org --- README.org | 52 +++++++++++++++++++++++++++++++++++++++++++++-- src/step9_try.cpp | 2 +- 2 files changed, 51 insertions(+), 3 deletions(-) diff --git a/README.org b/README.org index 4540f3b..595554e 100644 --- a/README.org +++ b/README.org @@ -3,6 +3,54 @@ #+LANGUAGE: en #+OPTIONS: toc:nil -* mal - Make a Lisp +This is my implementation of the [[https://github.com/kanaka/mal][Make A Lisp]] project, done in C++20. -This is my implementation of the [[https://github.com/kanaka/mal][Make A Lisp]] project, done in C++. +** Usage + +*** Run the REPL + +#+BEGIN_SRC shell-script +$ make +$ ./blaze +#+END_SRC +Or +#+BEGIN_SRC shell-script +$ make run +#+END_SRC + +*** Run mal tests + +Change the ~#if 0~ macro at the top of the ~stepX.cpp~ to ~#if 1~, then run the test: + +#+BEGIN_SRC shell-script +$ make test0 | less +#+END_SRC + +** Download + +*** Clone + +#+BEGIN_SRC shell-script +$ git clone https://github.com/riyyi/blaze +$ cd blaze +$ git submodule update --init --recursive +#+END_SRC +Or +#+BEGIN_SRC shell-script +$ git clone --recursive https://github.com/riyyi/blaze +#+END_SRC + +*** Update + +#+BEGIN_SRC shell-script +$ git pull +$ git submodule update --recursive +#+END_SRC + +** Build instructions + +#+BEGIN_SRC shell-script +$ mkdir build +$ cd build +$ cmake .. && make +#+END_SRC diff --git a/src/step9_try.cpp b/src/step9_try.cpp index c15b9a6..518f48d 100644 --- a/src/step9_try.cpp +++ b/src/step9_try.cpp @@ -24,7 +24,7 @@ #include "readline.h" #include "settings.h" -#if 1 +#if 0 namespace blaze { static EnvironmentPtr s_outer_env = Environment::create();