Skip to content

Commit

Permalink
Update build and test instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
bakpakin committed Oct 5, 2024
1 parent d30a461 commit ca774c4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
- name: Test Install
run: sudo janet -e '(bundle/install "spork")'
- name: Run Tests
run: cd spork && janet -l ./bundle -e "(test)"
run: cd spork && janet bundle/test.janet

test-windows:
name: Build and test on Windows
Expand Down Expand Up @@ -64,4 +64,4 @@ jobs:
- name: Run Tests
shell: cmd
run: |
refreshenv & cd spork & janet -l ./bundle -e "(test)"
refreshenv & cd spork & janet bundle/test.janet
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,30 @@ 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.
Expand Down

0 comments on commit ca774c4

Please sign in to comment.