Skip to content

Commit

Permalink
Restructure files and use vendored dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
pyrmont committed Sep 25, 2024
1 parent 01308a6 commit b8bb68d
Show file tree
Hide file tree
Showing 14 changed files with 1,903 additions and 130 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,4 @@ jobs:
- name: "Test project"
uses: pyrmont/action-janet-test@master
with:
cmd-deps: "jpm -l run dev-deps"
cmd-test: "jpm -l test"
cmd-test: "jpm test"
26 changes: 2 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ can be included in your repository and read easily on services like GitHub.

To install, run:

```console
```shell
$ jpm install https://github.com/pyrmont/documentarian
```

## Usage

```console
```shell
$ /path/to/documentarian
```

Expand Down Expand Up @@ -71,28 +71,6 @@ Documentarian supports the following command-line arguments:
-h, --help Show this help message.
```

## Development

### Preparing

Clone the repository and then run:

```console
$ jpm [-l] run dev-deps
```

### Building

```console
$ jpm [-l] build
```

### Testing

```console
$ jpm [-l] test
```

## Bugs

Found a bug? I'd love to know about it. The best way is to report your bug in
Expand Down
4 changes: 4 additions & 0 deletions bin/documentarian
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env janet
(import documentarian/lib/cli)

(cli/run)
19 changes: 19 additions & 0 deletions deps/argy-bargy/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2021 Michael Camilleri and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit b8bb68d

Please sign in to comment.