git @ Cat's Eye Technologies Whothm / implement-in-lua
Add README for Lua implementation. Chris Pressey 1 year, 10 months ago
1 changed file(s) with 31 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
+31
-0
impl/whothm.lua/README.md less more
0 `whothm.lua`
1 ============
2
3 This directory contains an implementation of Whothm in Lua 5.3,
4 called `whothm.lua`. Its source resides in the `src` subdirectory.
5
6 It also contains a demonstration of running `whothm.lua` in a
7 web browser, under [Fengari][], in the `demo` subdirectory.
8
9 In order to for this demonstration to work locally, you'll need
10 to run a local webserver from the *root* directory of this
11 repository. For example, if you have Python 3 installed,
12
13 python3 -m http.server
14
15 Then open
16
17 http://127.0.0.1:8000/impl/whothm.lua/demo/whothm.html
18
19 in your web browser. If you don't have Python, other options
20 (and more information on running web installations locally)
21 can be found here: [how to run things locally][].
22
23 Additionally, in the `bin` directory in the root of this repo,
24 there is a driver script called `whothm` whose purpose is to
25 properly run `whothm.lua` regardless of the current directory.
26 In other words, you can just put that bin dir on your `PATH`
27 and type `whothm` to run it.
28
29 [Fengari]: https://fengari.io/
30 [how to run things locally]: https://github.com/mrdoob/three.js/wiki/How-to-run-things-locally#run-local-server