From 1ac596be18d6c55380254a5a67896c441a4d0fc4 Mon Sep 17 00:00:00 2001 From: Rom DuPlain Date: Fri, 25 Oct 2019 15:59:23 -0700 Subject: [PATCH] Add Windows build to development README. --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a755ba1..5ab7f44 100644 --- a/README.md +++ b/README.md @@ -117,19 +117,25 @@ References: ### Development -With [Janet](https://janet-lang.org/) installed, build and test: +This project provides a single-command build to install a project-local Janet, +install dependencies, build, and test. On a Unix-like system, just run GNU Make +(`make`, which is sometimes `gmake` on BSD systems): ``` -[sudo] jpm deps # first time only -jpm test +make ``` -On a Unix-like system, just run GNU Make (`make`, which is sometimes `gmake` on -BSD systems) to install a project-local Janet, install dependencies, then build -and test the project, all in one command: +On Windows: ``` -make +.\bin\build.cmd +``` + +Otherwise, with [Janet](https://janet-lang.org/) installed, build and test: + +``` +[sudo] jpm deps # first time only +jpm test ``` The `build/` directory contains the `jpm build` (called by `jpm test`) output