clojure-lib-test/README.md
2025-07-04 15:39:24 +02:00

46 lines
1.4 KiB
Markdown

# com.travisshears/gum-utils
FIXME: my new library.
## Usage
FIXME: write usage documentation!
Invoke a library API function from the command-line:
$ clojure -X com.travisshears.gum-utils/foo :a 1 :b '"two"'
{:a 1, :b "two"} "Hello, World!"
Run the project's tests (they'll fail until you edit them):
$ clojure -T:build test
Run the project's CI pipeline and build a JAR (this will fail until you edit the tests to pass):
$ clojure -T:build ci
This will produce an updated `pom.xml` file with synchronized dependencies inside the `META-INF`
directory inside `target/classes` and the JAR in `target`. You can update the version (and SCM tag)
information in generated `pom.xml` by updating `build.clj`.
Install it locally (requires the `ci` task be run first):
$ clojure -T:build install
Deploy it to Clojars -- needs `CLOJARS_USERNAME` and `CLOJARS_PASSWORD` environment
variables (requires the `ci` task be run first):
$ clojure -T:build deploy
Your library will be deployed to com.travisshears/gum-utils on clojars.org by default.
## License
Copyright © 2025 She0001t
_EPLv1.0 is just the default for projects generated by `deps-new`: you are not_
_required to open source this project, nor are you required to use EPLv1.0!_
_Feel free to remove or change the `LICENSE` file and remove or update this_
_section of the `README.md` file!_
Distributed under the Eclipse Public License version 1.0.