Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.82 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.82 KB
Raw

Moon Garden

Moon Garden is a development streamlining tool for the Fennel programming language.
This tool is aimed to make the general purpose programming experience for Fennel smoother.
With help from the Fennel compiler, Moon Garden can compile .fnl to .lua files in a given directory as well as watching for file changes.

Installation

Moon Garden can be downloaded from LuaRocks

luarocks install moongarden

Usage

Moon Garden v0.1.0

Usage: moongarden [--path FILE|DIRECTORY] [--out DIRECTORY] [,--verbose] [,--watch]

Outputs a structure of folders / files containing .fnl files and outputs the same structure as .lua files

FLAGS
  --path      : Relative path of the input files - Default ./src
  --out       : Relative path of the output files - Default ./out
  --verbose   : Shows the build output - Defalt false
  --watch     : Watches for files changes and copies from [path] to [out] - Default false
  --version   : Shows the current build version of Moon Garden
  -h, --help  : Show this help text

About --watch

The --watch command relies on entr to watch when the .fnl files change as you save your work. Entr works on UNIX based systems and will need to be installed locally. Moon Garden will tell you if you don't have Entr installed if you try to use the --watch flag. You can use WSL (Windows Subsystem for Linux) when using Windows.

Contributing

  1. Fork the repo.
  2. Make your changes.
  3. Submit a PR!
  4. ...profit?

Having Issues?

Let me know!

License

Copyright © 2021-2021 Bradyn Glines

Released under the MIT license.

TODO:

  • Get file writing tests working