Add readme describing repo and how to run tests

This commit is contained in:
Camden Dixie O'Brien 2023-12-11 15:40:11 +00:00
parent 7c95a358ad
commit 1acded5363

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Lua Exercises
This repo contains some Lua exercises along with automated tests for
their solutions. Each file contains a description of the problem and
an area for your solution as well as the tests. Feel free to define
as many functions and constants as you need in the solution area, but
do not modify the tests.
To run the tests and check your solution for a given exercise, simply
run `lua <the-file>`. For example, if you were working on the
anagrams exercise, you would run `lua xxx_anagrams.lua`. For each
exercise, the tests should run in well under a tenth of a second; if
it takes longer than this you should try to speed up your solution.