Commit 63d0900a1fcab06d5292044c4be00a318eb9dbef - Velo

Update velo.lua's README. Chris Pressey 6 years ago

1 changed file(s) with 18 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all

+18

-4

impl/velo.lua/README.md less more

	0	velo.lua
	1	========
	2
0	3	This directory contains an implementation of Velo in Lua 5.1,
1		`velo.lua`, in the `src` subdirectory.
	4	called `velo.lua`. Its source resides in the `src` subdirectory.
2	5
3	6	It also contains a demonstration of running `velo.lua` in a
4		web browser, under Fengari, in the `demo` subdirectory`.
	7	web browser, under [Fengari][], in the `demo` subdirectory.
5	8
6	9	In order to for this demonstration to work locally, you'll need
7	10	to run a local webserver from the root directory of this
8		repository. If you have Python installed,
	11	repository. For example, if you have Python installed,
9	12
10	13	python -m SimpleHTTPServer
11	14

13	16
14	17	http://127.0.0.1:8000/impl/velo.lua/demo/velo.html
15	18
16		in your web browser.
	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 `velo_lua` whose purpose is to
	25	properly run `velo.lua` regardless of the current directory.
	26	In other words, you can just put that bin dir on your `PATH`
	27	and type `velo_lua` 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⏎