Skip to content

Commit 3f9cc7a

Browse files
committed
update readme
1 parent 076a47f commit 3f9cc7a

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
[![project docs](https://img.shields.io/badge/docs-website-blueviolet)](https://jodersky.github.io/scala-argparse)
44
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://crashbox.zulipchat.com/#narrow/stream/330744-argparse)
5-
[![Latest version][scaladex-badge]][scaladex-link]
5+
[![latest version][scaladex-badge]][scaladex-link]
6+
[![stability: firm](https://img.shields.io/badge/stability-firm-silver)](https://www.crashbox.io/stability.html)
67

78
[scaladex-badge]: https://index.scala-lang.org/jodersky/scala-argparse/argparse/latest.svg
89
[scaladex-link]: https://index.scala-lang.org/jodersky/scala-argparse/argparse
@@ -26,5 +27,24 @@ Pragmatic command line parsing for Scala applications.
2627

2728
## Docs
2829

29-
Look at the [website](https://jodersky.github.io/scala-argparse), or,
30-
equivalently, browse the docs/ folder.
30+
- HTML: look at the [website](https://jodersky.github.io/scala-argparse)
31+
- source (markdown): browse the docs/ folder.
32+
33+
## Building
34+
35+
This project uses [Mill](https://github.com/com-lihaoyi/mill) to build. The
36+
configuration is in the `build.sc` file.
37+
38+
### Developer
39+
40+
- compile main project for all supported versions of scala: `./mill argparse.__.compile`
41+
- run all tests: `./mill __.test`
42+
- run an example:
43+
- `./mill examples.<name of example> <arguments>`
44+
- e.g. `./mill examples.paramnamed --verbosity 5`
45+
- note: examples use Scala Native and hence require llvm
46+
- publish main project locally: `./mill argparse.__.publishLocal`
47+
48+
### Maintainer
49+
50+
Look at the scripts in the `ci/` directory.

0 commit comments

Comments
 (0)