Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.88 KB

README.md

File metadata and controls

53 lines (35 loc) · 1.88 KB
Raw

Spork

test

Various Janet utility modules. Spork aims to be grab bag of useful Janet functionality that does not belong in the core library.

To use all features mentioned below in one program you can do (use spork) to import them. When you need only part of the functionality, please use import as seen in the example for the part.

Build

janet bundle/build.janet

Test

janet bundle/test.janet

Installation

[sudo] jpm install spork

Alternatively,

[sudo] janet -e '(bundle/install ".")'

Dependencies

Spork contains third-party dependencies in the deps/ directory. All dependencies are MIT/X11 licensed, or public domain. Licenses for individual components can be found along with the source code in the deps/ directory.

Documentation

Spork's documentation is written using Mendoza. The docs are most easily read by first building and then serving the .mdz files in doc/ using Mendoza. You can then access the served static site using a browser.

  • First, make sure you have Janet and jpm installed. See the Janet docs for more information on this.
  • Next, install Mendoza (to install globally, run [sudo] jpm install mendoza). For more information on Mendoza, see the Mendoza project on GitHub.
  • Clone this repo locally (e.g. using git clone https://github.com/janet-lang/spork.git).
  • From the spork project root (cd spork if you just cloned it) run mdz build && mdz serve.

While the Mendoza server process is running, you can navigate to http://localhost:8000 to view the spork docs as a static site.