diff options
author | Eduardo Julian | 2016-12-01 11:00:44 -0400 |
---|---|---|
committer | Eduardo Julian | 2016-12-01 11:00:44 -0400 |
commit | 7f66c54f4c9753b94dbf46ec50b8b16549daf324 (patch) | |
tree | 1b5b896cfba870a66a99a03315b09df842eb5737 /lux-lein/README.md | |
parent | 9c30546af022f8fe36b73e7e93414257ff28ee75 (diff) |
- Collected the Lux compiler's repo, the Standard Library's, the Leiningen plugin's and the Emacs mode's into a big monorepo, to keep development unified.
Diffstat (limited to '')
-rw-r--r-- | lux-lein/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/lux-lein/README.md b/lux-lein/README.md new file mode 100644 index 000000000..6d024a58f --- /dev/null +++ b/lux-lein/README.md @@ -0,0 +1,27 @@ +# How to use it + +You'll need a project.clj that imports the lein-luxc plugin. + +Here's an example: + +``` +(defproject com.github.luxlang/lux-stdlib "0.4.0" + :description "Standard library for the Lux programming language." + :url "https://github.com/LuxLang/stdlib" + :license {:name "Mozilla Public License (Version 2.0)" + :url "https://www.mozilla.org/en-US/MPL/2.0/"} + :plugins [[com.github.luxlang/lein-luxc "0.3.0"]] + :source-paths ["source"] + ) + +``` + +Now, all you need to do is run the plugin like this: + + lein luxc compile + +And, if you want to run unit-tests, you can do: + + lein luxc test + +Those unit tests must be in the `test` directory on your project root. |