X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/a000c39cc591c6bacc37ae5f4dcfc87e55e6cd5f..6cd451ca8feb3c050587dc80b2f11699c0fbc532:/README.md diff --git a/README.md b/README.md index 837ace4..ef2efcf 100644 --- a/README.md +++ b/README.md @@ -17,24 +17,34 @@ This application is implemented in [Nim language](https://nim-lang.org). ## Usage -### As a script +Download the latest build from GitlabCI -You must have nim installed locally for this to work. +```sh +wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip +unzip artifacts.zip +``` + +Run the binary ```sh -nim c -d:ssl -r cli_tube.nim emacs +./clitube emacs -# If your search query has multiple words, use quotes -nim c -d:ssl -r cli_tube.nim 'nim lang' +./clitube 'nim lang' ``` -### Using the binary +## Development -Please use the binary in the repository for now. -Will setup GitLab CI to publish proper binaries later. +### Compiling and Running ```sh -./cli_tube emacs +nim c -d:ssl -r clitube.nim emacs -./cli_tube 'nim lang' +# If your search query has multiple words, use quotes +nim c -d:ssl -r clitube.nim 'nim lang' +``` + +### Creating a release artifact + +```sh +nim c -d:ssl -d:release clitube.nim ```