kanaka/mal
1
1
Fork 0
mirror of https://github.com/kanaka/mal.git synced 2024-11-10 12:47:45 +03:00
Code Issues Projects Releases Wiki Activity

Tweaking text in guide.

Browse Source 
Referring to the pseudocode in the process/ directory is important, but
it's easy to miss that detail when reading the guide for the first time.

Similarly, it's important to add a new Makefile in many cases, so
reformat to draw attention to that.
This commit is contained in:
Wilfred Hughes 2016-03-24 21:49:00 +00:00
parent c589fa779e
commit 5c0526927a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
process/guide.md
View File

@ -116,7 +116,9 @@ make "test^quux^stepX"
TODO: If your implementation language is a compiled language, then you
should also add a Makefile at the top level of your implementation
directory that will define how to build the files pointed to by the
directory.
Your Makefile will define how to build the files pointed to by the
quux_STEP_TO_PROG macro. The top-level Makefile will attempt to build
those targets before running tests. If it is a scripting
language/uncompiled, then no Makefile is necessary because
@ -162,6 +164,8 @@ a bunch of tests associated with it and there is an easy script to run
all the tests for a specific step in the process. Pick a failing test,
fix it, repeat until all the tests for that step pass.
## Reference Code
The `process` directory contains abbreviated pseudocode and
architecture images for each step of the make-a-lisp process. Use
a textual diff/comparison tool to compare the previous pseudocode step