Updated README.md for the `examples` folder to include some starting points.
[vvhitespace] / examples / README.md
CommitLineData
92a92075
AT
1# Overview #
2
5837024c
AT
3This folder contains example VVhitespace programs. If you're just getting
4started, you probably want to read the `hello-world` and
5`basic-user-interaction` examples first.
92a92075
AT
6
7Each program can be built and run by executing `make run` in the example
8sub-directory.
9
10Running `make clean` in a specific example sub-directory will clean up all
11build-related files for that example. Executing the same command in the
12top-level `examples/` directory will clean up every example.
13
14Before running any examples, first run `make` in the top-level VVhitespace
15folder to build `vvc` and `vvi`.