Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janet-lang/spork
Various Janet utility modules - the official "Contrib" library.
https://github.com/janet-lang/spork
Last synced: 5 days ago
JSON representation
Various Janet utility modules - the official "Contrib" library.
- Host: GitHub
- URL: https://github.com/janet-lang/spork
- Owner: janet-lang
- License: mit
- Created: 2020-04-29T00:37:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-31T18:15:27.000Z (13 days ago)
- Last Synced: 2024-12-31T19:21:07.041Z (13 days ago)
- Language: Janet
- Homepage:
- Size: 744 KB
- Stars: 130
- Watchers: 9
- Forks: 36
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-janet - Spork
README
# Spork
[](https://github.com/janet-lang/spork/actions/workflows/test.yml)
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](https://github.com/bakpakin/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](https://janet-lang.org/) and [jpm](https://janet-lang.org/docs/jpm.html) installed. See [the Janet docs](https://janet-lang.org/introduction.html) 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](https://github.com/bakpakin/mendoza).
- 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.