Skip to content

Commit

Permalink
Rename project to 'Mari'
Browse files Browse the repository at this point in the history
  • Loading branch information
hwittenborn committed Aug 4, 2022
1 parent 8827f1a commit 52b97b7
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 82 deletions.
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.7.0] - 2022-08-04
### Changed
- Renamed project to `Mari`.

## [0.6.2] - 2022-08-03
### Added
Added symlink in PKGBUILD for ease of transition from `mpr-cli` to `mist`.
- Added symlink in PKGBUILD for ease of transition from `mpr-cli` to `mist`.

## [0.6.1] - 2022-08-03
### Added
Added needed fields in PKGBUILD for transition from `mpr-cli` to `mist`.
- Added needed fields in PKGBUILD for transition from `mpr-cli` to `mist`.

## [0.6.0] - 2022-08-03
### Changed
Renamed project to `Mist`.
- Renamed project to `Mist`.

## [0.5.0] - 2022-07-23
### Added
Expand Down
44 changes: 22 additions & 22 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "mist"
name = "mari"
version = "0.6.2"
authors = ["Hunter Wittenborn <[email protected]"]
description = "The official command-line interface for the makedeb Package Repository"
edition = "2021"
homepage = "https://github.com/makedeb/mist"
repository = "https://github.com/makedeb/mist"
homepage = "https://github.com/makedeb/mari"
repository = "https://github.com/makedeb/mari"
license = "GPL-3.0-or-later"
keywords = ["makedeb", "mpr", "apt", "mpr-helper", "helper"]
categories = ["command-line-utilities"]
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Mist
This is the repository for Mist, the official helper for the makedeb Package Repository.
# Mari
This is the repository for Mari, the official helper for the makedeb Package Repository.

[![Latest deployment status](https://img.shields.io/drone/build/makedeb/mist?logo=drone&server=https%3A%2F%2Fdrone.hunterwittenborn.com)](https://drone.hunterwittenborn.com/makedeb/mist/latest)
[![Latest deployment status](https://img.shields.io/drone/build/makedeb/mari?logo=drone&server=https%3A%2F%2Fdrone.hunterwittenborn.com)](https://drone.hunterwittenborn.com/makedeb/mari/latest)

## Installation
Users have a few options for installing Mist:
Users have a few options for installing Mari:

### From the Prebuilt-MPR
This is the recommended way to install Mist. It avoids the need to compile any software, allows for automatic upgrades via APT, and gets you set up in just a couple of minutes.
This is the recommended way to install Mari. It avoids the need to compile any software, allows for automatic upgrades via APT, and gets you set up in just a couple of minutes.

First, [set up the Prebuilt-MPR on your system](https://docs.makedeb.org/prebuilt-mpr/getting-started), then just run the following to install Mist:
First, [set up the Prebuilt-MPR on your system](https://docs.makedeb.org/prebuilt-mpr/getting-started), then just run the following to install Mari:

```sh
sudo apt install mist
sudo apt install mari
```

### From the MPR
You can also install Mist directly from the MPR if you'd prefer that.
You can also install Mari directly from the MPR if you'd prefer that.

To install from source, run the following:

```sh
git clone 'https://mpr.makedeb.org/mist'
cd mist/
git clone 'https://mpr.makedeb.org/mari'
cd mari/
makedeb -si
```

> Mist needs the latest version of the Rust compiler toolchain in order to build. It may work with older releases, but they're not tested against and aren't guaranteed to work. If you're system's repositories don't contain the latest release, the Rust toolchain can be installed from the [MPR](https://mpr.makedeb.org/packages/rustc) or the Prebuilt-MPR.
> Mari needs the latest version of the Rust compiler toolchain in order to build. It may work with older releases, but they're not tested against and aren't guaranteed to work. If you're system's repositories don't contain the latest release, the Rust toolchain can be installed from the [MPR](https://mpr.makedeb.org/packages/rustc) or the Prebuilt-MPR.
## Contributing
If there's something you want added/fixed in Mist, feel free to open a pull request. There aren't many guidelines on what you should do quite yet, so just submit your changes and we can figure out what to do from there!
If there's something you want added/fixed in Mari, feel free to open a pull request. There aren't many guidelines on what you should do quite yet, so just submit your changes and we can figure out what to do from there!
38 changes: 19 additions & 19 deletions completions/mist.bash → completions/mari.bash
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
_mist_get_pkglist() {
_mari_get_pkglist() {
mapfile -t opts < <("${words[0]}" pkglist)
}

_mist_gen_compreply() {
_mari_gen_compreply() {
mapfile -t COMPREPLY < <(compgen -W "${1}" -- "${2}")
}

_mist_pkg_specified_check() {
_mari_pkg_specified_check() {
if [[ "${#nonopts[@]}" -gt 3 ]]; then
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
else
_mist_get_pkglist
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_get_pkglist
_mari_gen_compreply '${opts[@]}' "${cur}"
fi
}

_mist() {
_mari() {
local cur prev words cword
_init_completion || return

Expand Down Expand Up @@ -52,11 +52,11 @@ _mist() {

case "${cur}" in
-*)
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
return
;;
*)
_mist_pkg_specified_check
_mari_pkg_specified_check
return
;;
esac
Expand All @@ -71,11 +71,11 @@ _mist() {
opts+=('--msg')
case "${cur}" in
-*)
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
return
;;
*)
_mist_pkg_specified_check
_mari_pkg_specified_check
return
;;
esac
Expand All @@ -90,19 +90,19 @@ _mist() {
;;
--paging)
opts=('auto' 'never' 'always')
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
return
;;
esac

opts+=('--paging')
case "${cur}" in
-*)
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
return
;;
*)
_mist_pkg_specified_check
_mari_pkg_specified_check
return
;;
esac
Expand All @@ -117,11 +117,11 @@ _mist() {
opts+=('--apt-only' '--mpr-only')
case "${cur}" in
-*)
_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
return
;;
*)
_mist_pkg_specified_check
_mari_pkg_specified_check
return
;;
esac
Expand All @@ -133,7 +133,7 @@ _mist() {
;;
esac

_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
;;
whoami)
case "${prev}" in
Expand All @@ -142,11 +142,11 @@ _mist() {
;;
esac

_mist_gen_compreply '${opts[@]}' "${cur}"
_mari_gen_compreply '${opts[@]}' "${cur}"
return
;;
esac
}

complete -F _mist mist
complete -F _mari mari
# vim: set sw=4 expandtab:
22 changes: 11 additions & 11 deletions makedeb/PKGBUILD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Maintainer: Hunter Wittenborn <[email protected]>
pkgname=mist
pkgver=0.6.2
pkgname=mari
pkgver=0.7.0
pkgrel=1
pkgdesc='The official helper for the makedeb Package Repository'
arch=('any')
Expand All @@ -17,10 +17,10 @@ makedepends=(
'pkg-config'
)
license=('GPL3')
url='https://github.com/makedeb/mist'
url='https://github.com/makedeb/mari'

# Transition stuff for the package rename from 'mpr-cli' to 'mist'.
conflicts=('mpr-cli<0.5.2')
# Transition stuff for the package rename from 'mist' to 'mari'.
conflicts=('mari<0.7.0')
replaces=("${conflicts[@]}")

source=("${url}/archive/refs/tags/v${pkgver}.tar.gz")
Expand All @@ -30,17 +30,17 @@ build() {
cd "${pkgname}-${pkgver}/"
cargo build --release

sed -i "s|:mansource: Git|:mansource: ${pkgver}|" man/mist.1.adoc
sed -i "s|:mansource: Git|:mansource: ${pkgver}|" man/mari.1.adoc
}

package() {
cd "${pkgname}-${pkgver}/"
install -Dm 755 target/release/mist "${pkgdir}/usr/bin/mist"
asciidoctor -b manpage -o - man/mist.1.adoc | install -Dm 644 /dev/stdin "${pkgdir}/usr/share/man/man1/mist.1"
install -Dm 644 completions/mist.bash "${pkgdir}/usr/share/bash-completion/completions/mist"
install -Dm 755 target/release/mari "${pkgdir}/usr/bin/mari"
asciidoctor -b manpage -o - man/mari.1.adoc | install -Dm 644 /dev/stdin "${pkgdir}/usr/share/man/man1/mari.1"
install -Dm 644 completions/mari.bash "${pkgdir}/usr/share/bash-completion/completions/mari"

# Transition stuff for the package rename from 'mpr-cli' to 'mist'.
ln -s '/usr/bin/mist' "${pkgdir}/usr/bin/mpr"
# Transition stuff for the package rename from 'mist' to 'mari'.
ln -s '/usr/bin/mari' "${pkgdir}/usr/bin/mist"
}

# vim: set sw=4 expandtab:
24 changes: 12 additions & 12 deletions man/mist.1.adoc → man/mari.1.adoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
= MAKEDEB(1)
:doctype: manpage
:hardbreaks:
:manmanual: Mist
:manmanual: Mari
:mansource: Git

== NAME
mist - The official helper for the makedeb Package Repository
mari - The official helper for the makedeb Package Repository

== SYNOPSIS
*mist* clone _pkgbase_ [_options_] ...
*mist* comment _pkgbase_ [_options_] ...
*mist* info _pkgname_ [_options_] ...
*mist* list-comments _pkgbase_ [_options_] ...
*mist* search _query_ ... [_options_] ...
*mist* update
*mist* whoami [_options_] ...
*mari* clone _pkgbase_ [_options_] ...
*mari* comment _pkgbase_ [_options_] ...
*mari* info _pkgname_ [_options_] ...
*mari* list-comments _pkgbase_ [_options_] ...
*mari* search _query_ ... [_options_] ...
*mari* update
*mari* whoami [_options_] ...

== DESCRIPTION
*mist* is a command-line interface for interacting with the makedeb Package Repository.
*mari* is a command-line interface for interacting with the makedeb Package Repository.

The *comment* and *whoami* commands both require authentication via an API key in order to run. An API key can be obtained via the MPR web interface on the user's account page, and can be passed into this program via the *--token* argument or the *MPR_TOKEN* environment variable, the former being described in *OPTIONS*, and the latter in *ENVIRONMENT*.

Expand Down Expand Up @@ -48,7 +48,7 @@ Run each command with *--help* to see available options.
== BUGS
Issues, as well as feature requests, should be reported on the project's GitHub page:

https://github.com/makedeb/mist/issues
https://github.com/makedeb/mari/issues

Matrix is also used as our primary method of real-time communication, being where most discussions (outside of the issue tracker) take place. All rooms are joined via a Matrix space, which can be accessed via the following:

Expand All @@ -57,7 +57,7 @@ Matrix is also used as our primary method of real-time communication, being wher
== AUTHORS
Hunter Wittenborn <\[email protected]>

A full list of contributors can be found by running *git shortlog -esn* in the Mist's Git repository (linked under *BUGS*).
A full list of contributors can be found by running *git shortlog -esn* in the Mari's Git repository (linked under *BUGS*).

== SEE ALSO
*makedeb*(8)

0 comments on commit 52b97b7

Please sign in to comment.