Skip to content

Commit

Permalink
rename gobang -> zhobo
Browse files Browse the repository at this point in the history
  • Loading branch information
kyoto7250 committed Jun 16, 2024
1 parent 046c367 commit e102018
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 40 deletions.
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Thank you for making gobang better!
Thank you for making zhobo better!

Here's a checklist for things that will be checked during review or continuous integration.

Expand Down
20 changes: 10 additions & 10 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
name: Release
runs-on: ${{ matrix.os }}
outputs:
gobang_version: ${{ env.GOBANG_VERSION }}
zhobo_version: ${{ env.zhobo_VERSION }}
env:
# For some builds, we use cross to test on 32-bit and big-endian
# systems.
Expand Down Expand Up @@ -50,13 +50,13 @@ jobs:
steps:
- name: Get the release version from the tag
shell: bash
if: env.GOBANG_VERSION == ''
if: env.zhobo_VERSION == ''
run: |
# Apparently, this is the right way to get a tag name. Really?
#
# See: https://git.luolix.topmunity/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027
echo "GOBANG_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
echo "version is: ${{ env.GOBANG_VERSION }}"
echo "zhobo_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
echo "version is: ${{ env.zhobo_VERSION }}"
- name: Checkout repository
uses: actions/checkout@v2
Expand Down Expand Up @@ -90,7 +90,7 @@ jobs:

- name: Strip release binary (linux and macos)
if: matrix.build == 'linux' || matrix.build == 'macos'
run: strip "target/${{ matrix.target }}/release/gobang"
run: strip "target/${{ matrix.target }}/release/zhobo"

- name: Strip release binary (arm)
if: matrix.build == 'linux-arm'
Expand All @@ -99,23 +99,23 @@ jobs:
"$PWD/target:/target:Z" \
rustembedded/cross:arm-unknown-linux-gnueabihf \
arm-linux-gnueabihf-strip \
/target/arm-unknown-linux-gnueabihf/release/gobang
/target/arm-unknown-linux-gnueabihf/release/zhobo
- name: Build archive
shell: bash
run: |
staging="gobang-${{ env.GOBANG_VERSION }}-${{ matrix.target }}"
staging="zhobo-${{ env.zhobo_VERSION }}-${{ matrix.target }}"
mkdir -p "$staging"/{complete,doc}
cp {README.md,LICENSE} "$staging/"
if [ "${{ matrix.os }}" = "windows-2019" ]; then
cp "target/${{ matrix.target }}/release/gobang.exe" "$staging/"
cp "target/${{ matrix.target }}/release/zhobo.exe" "$staging/"
7z a "$staging.zip" "$staging"
echo "ASSET=$staging.zip" >> $GITHUB_ENV
else
# The man page is only generated on Unix systems. ¯\_(ツ)_/¯
cp "target/${{ matrix.target }}/release/gobang" "$staging/"
cp "target/${{ matrix.target }}/release/zhobo" "$staging/"
tar czf "$staging.tar.gz" "$staging"
echo "ASSET=$staging.tar.gz" >> $GITHUB_ENV
fi
Expand Down Expand Up @@ -146,4 +146,4 @@ jobs:
cargo workspaces publish \
--yes --force '*' --exact \
--no-git-commit --allow-dirty --skip-published --token ${{ secrets.CRATES_IO_TOKEN }} \
custom ${{ needs.release.outputs.gobang_version }}
custom ${{ needs.release.outputs.zhobo_version }}
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/target
gobang
gobang.yml
gobang.log
zhobo
zhobo.yml
zhobo.log
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<div align="center">

![gobang](./resources/logo.png)
![zhobo](./resources/logo.png)

gobang is currently in alpha
zhobo is currently in alpha

A cross-platform TUI database management tool written in Rust

[![github workflow status](https://img.shields.io/github/workflow/status/TaKO8Ki/gobang/CI/main)](https://github.com/TaKO8Ki/gobang/actions) [![crates](https://img.shields.io/crates/v/gobang.svg?logo=rust)](https://crates.io/crates/gobang)
[![github workflow status](https://img.shields.io/github/workflow/status/kyoto7250/zhobo/CI/main)](https://github.com/kyoto7250/zhobo/actions) [![crates](https://img.shields.io/crates/v/zhobo.svg?logo=rust)](https://crates.io/crates/zhobo)

![gobang](./resources/gobang.gif)
![zhobo](./resources/zhobo.gif)

</div>

Expand All @@ -25,74 +25,74 @@ A cross-platform TUI database management tool written in Rust
- [ ] Custom theme settings
- [ ] Support the other databases

## What does "gobang" come from?
## What does "zhobo" come from?

gobang means a Japanese game played on goban, a go board. The appearance of goban looks like table structure. And I live in Kyoto, Japan. In Kyoto city, streets are laid out on a grid (We call it “goban no me no youna (碁盤の目のような)”). They are why I named this project "gobang".
zhobo means a Japanese game played on goban, a go board. The appearance of goban looks like table structure. And I live in Kyoto, Japan. In Kyoto city, streets are laid out on a grid (We call it “goban no me no youna (碁盤の目のような)”). They are why I named this project "zhobo".

## Installation

### With Homebrew (Linux, macOS)

If you’re using Homebrew or Linuxbrew, install the gobang formula:
If you’re using Homebrew or Linuxbrew, install the zhobo formula:

```
brew install tako8ki/tap/gobang
brew install kyoto7250/tap/zhobo
```

### On Windows

If you're a Windows Scoop user, then you can install gobang from the [official bucket](https://github.com/ScoopInstaller/Main/blob/master/bucket/gobang.json):
If you're a Windows Scoop user, then you can install zhobo from the [official bucket](https://github.com/ScoopInstaller/Main/blob/master/bucket/zhobo.json):

```
scoop install gobang
scoop install zhobo
```
### On NixOS

If you're a Nix user, you can install [gobang](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/database/gobang/default.nix) from nixpkgs:
If you're a Nix user, you can install [zhobo](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/database/zhobo/default.nix) from nixpkgs:

```
$ nix-env --install gobang
$ nix-env --install zhobo
```

### On Archlinux

If you're an Archlinux user, you can install [gobang](https://aur.archlinux.org/packages/gobang-bin) from AUR:
If you're an Archlinux user, you can install [zhobo](https://aur.archlinux.org/packages/zhobo-bin) from AUR:

```
paru -S gobang-bin
paru -S zhobo-bin
```

### On NetBSD

If you're a NetBSD user, then you can install gobang from [pkgsrc](https://pkgsrc.se/databases/gobang):
If you're a NetBSD user, then you can install zhobo from [pkgsrc](https://pkgsrc.se/databases/zhobo):

```
pkgin install gobang
pkgin install zhobo
```

### With Cargo (Linux, macOS, Windows)

If you already have a Rust environment set up, you can use the `cargo install` command:

```
cargo install --version 0.1.0-alpha.5 gobang
cargo install --version 0.1.0-alpha.5 zhobo
```

### From binaries (Linux, macOS, Windows)

- Download the [latest release binary](https://github.com/TaKO8Ki/gobang/releases) for your system
- Download the [latest release binary](https://github.com/kyoto7250/zhobo/releases) for your system
- Set the `PATH` environment variable

## Usage

```
$ gobang
$ zhobo
```

```
$ gobang -h
$ zhobo -h
USAGE:
gobang [OPTIONS]
zhobo [OPTIONS]
FLAGS:
-h, --help Prints help information
Expand Down Expand Up @@ -124,9 +124,9 @@ If you want to add connections, you need to edit your config file. For more info

The location of the file depends on your OS:

- macOS: `$HOME/.config/gobang/config.toml`
- Linux: `$HOME/.config/gobang/config.toml`
- Windows: `%APPDATA%/gobang/config.toml`
- macOS: `$HOME/.config/zhobo/config.toml`
- Linux: `$HOME/.config/zhobo/config.toml`
- Windows: `%APPDATA%/zhobo/config.toml`

The following is a sample config.toml file:

Expand Down
2 changes: 1 addition & 1 deletion sample.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ port = 3306

[[conn]]
type = "mysql"
user = "tako8ki"
user = "kyoto7250"
host = "localhost"
port = 3306
database = "world"
Expand Down

0 comments on commit e102018

Please sign in to comment.