Skip to content

Commit

Permalink
Make installation instructions in README easier to copy.
Browse files Browse the repository at this point in the history
  • Loading branch information
@fredrikekre
fredrikekre committed Apr 22, 2022
1 parent 3d45ae1 commit 53fa79d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,17 +128,17 @@ Keyword arguments:
It is possible to download and extract a prebuilt script with default settings.
For example, to download the latest release you can run the following
```bash
$ curl -fsSL https://github.com/fredrikekre/jlpkg/releases/download/v1.5.1/jlpkg-v1.5.1.tar.gz | \
tar -xzC /usr/local/bin
curl -fsSL https://github.com/fredrikekre/jlpkg/releases/download/v1.5.1/jlpkg-v1.5.1.tar.gz | \
tar -xzC /usr/local/bin
```
This will extract the executable script `jlpkg` and place it in `/usr/local/bin`.
You can of course replace `/usr/local/bin` with any writable folder in your `PATH`.
When using the prebuilt script it is assumed that `julia` is also in your `PATH`.

The Bash completion file can also be downloaded from the repo. For example:
```bash
$ curl -fsSL -o ~/.bash_completion.d/jlpkg-completion.bash \
https://raw.githubusercontent.com/fredrikekre/jlpkg/v1.5.1/src/jlpkg-completion.bash
curl -fsSL -o ~/.bash_completion.d/jlpkg-completion.bash \
https://raw.githubusercontent.com/fredrikekre/jlpkg/v1.5.1/src/jlpkg-completion.bash
```
Make sure to source this file in your shell startup file. For example, add the following to `~/.bashrc`:
```bash
Expand Down

2 comments on commit 53fa79d

@fredrikekre
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/58953

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.5.1 -m "<description of version>" 53fa79d1ea1547a9e7b14dded3d5742c43f05f82
git push origin v1.5.1

Please sign in to comment.