Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): update README #14

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"recommendations": [
"EditorConfig.EditorConfig",
"yzhang.markdown-all-in-one",
"foxundermoon.shell-format",
"timonwong.shellcheck",
"streetsidesoftware.code-spell-checker",
"jetmartin.bats",
"redhat.vscode-yaml",
],
"unwantedRecommendations": []
}
4 changes: 4 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"cloudcode.yaml.format.singleQuote": true,
"yaml.format.singleQuote": true
}
66 changes: 57 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,70 @@
# asdf-gitui
# asdf-gitui <!-- omit in toc -->

![AllInOne](https://github.com/looztra/asdf-gitui/workflows/AllInOne/badge.svg)
[![Build](https://github.com/looztra/asdf-gitui/actions/workflows/code_checks.yml/badge.svg)](https://github.com/looztra/asdf-gitui/actions/workflows/code_checks.yml)
[![Build](https://github.com/looztra/asdf-gitui/actions/workflows/workflows_checks.yml/badge.svg)](https://github.com/looztra/asdf-gitui/actions/workflows/workflows_checks.yml)
[![GitHub license](https://img.shields.io/github/license/looztra/asdf-gitui?style=plastic)](https://github.com/looztra/asdf-gitui/blob/master/LICENSE)

[gitui](https://github.com/extrawurst/gitui) plugin for the [asdf version manager](https://asdf-vm.com).

## Contents

- [Contents](#contents)
- [Build History](#build-history)
- [Dependencies](#dependencies)
- [Install](#install)
- [add the plugin](#add-the-plugin)
- [install gitui](#install-gitui)
- [Contributing](#contributing)
- [License](#license)

## Build History

[![Build history](https://buildstats.info/github/chart/looztra/asdf-gitui?branch=master)](https://github.com/looztra/asdf-gitui/actions)
[![Build history](https://buildstats.info/github/chart/looztra/asdf-gitui?branch=main)](https://github.com/looztra/asdf-gitui/actions)

## gitui
## Dependencies

<https://github.com/extrawurst/gitui>
- `bash`, `curl`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html).
- a python 3 runtime (provided through [asdf-python](https://github.com/asdf-community/asdf-python) or not)

## Install

```bash
asdf plugin-add gitui https://github.com/looztra/asdf-gitui
### add the plugin

```shell
asdf plugin add gitui
```

## Use
Or:

```shell
asdf plugin add copier https://github.com/looztra/asdf-copier.git
```

### install gitui

```shell
# Show all installable versions
asdf list all gitui

# Install latest version
asdf install gitui latest

# Set a version globally (on your ~/.tool-versions file)
asdf global gitui latest

# Now copier commands are available
gitui --help
```

Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
install & manage versions.

## Contributing

Contributions of any kind welcome! See the [contributing guide](contributing.md).

[Thanks goes to these contributors](https://github.com/looztra/asdf-gitui/graphs/contributors)!

## License

Check out the [asdf](https://github.com/asdf-vm/asdf) readme for instructions on how to install and manage versions of gitui.
See [LICENSE](LICENSE) © [Christophe Furmaniak](https://github.com/looztra/)