docs: Install Qob

README.md

@@ -20,43 +20,6 @@ We are currently in a *early-development* phase.  API, and commands are not stab
 
 Things might still break at any point.
 
-## 🔧 Usage
-
-```
-NAME:
-  qob - CLI for building, running, testing, and managing your Common Lisp dependencies
-
-USAGE:
-  qob [global-options] [<command>] [command-options] [arguments ...]
-
-OPTIONS:
-      --help           display usage information and exit
-      --no-color       enable/disable color output
-      --version        display version and exit
-  -a, --all            enable all flag
-  -g, --global         change default workspace to ~/.qob/
-  -v, --verbose <INT>  set verbosity from 0 to 5 [default: 3]
-
-COMMANDS:
-  build          Build the executable
-  clean          Delete various files produced during building
-  create         Create a new Common Lisp project
-  dists          List out all installed dists
-  info           Display information about the current system(s)
-  install        Install systems
-  install-deps   Automatically install system dependencies
-  install-dists  Install dists
-  list           List the registered system
-  status         Display the state of the workspace
-  uninstall      Uninstall systems
-
-AUTHORS:
-  Jen-Chieh Shen <jcs090218@gmail.com>
-
-LICENSE:
-  MIT
-```
-
 ## 🔨 Development
 
 You need the following softwares:

docs/content/Contributing/Developing-Qob/_index.en.md

@@ -0,0 +1,49 @@
+---
+title: 🔨 Developing Qob
+weight: 20
+---
+
+{{< toc >}}
+
+### 🚩 Prerequisites
+
+To make changes to Qob, you should have:
+
+1. [SBCL][] for the lisp implementation.
+2. [Make][] for the build system.
+3. [Quicklisp][] for CL package manager.
+
+### 📝 Building
+
+To build the development environment, you would have to install Qob using
+the [build from source](https://cl-qob.github.io/Getting-Started/Install-Qob/#-build-from-source)
+method. Make sure you have set up the environment PATH variable, so you can call
+`qob` from the terminal.
+
+After you have stepped through the installation, try:
+
+```sh
+$ qob locate
+```
+
+It should print out the location of the `qob` executable.
+You should be able to identify the Qob executable's location,
+even you have multiple Qob versions installed!
+
+### 📈 Testing
+
+Qob does not offer local testing, all our tests are accomplished using GitHub
+Actions. Please fork our repository, and push your changes to your fork. GitHub
+Actions should pick up the test for you!
+
+Make sure you have GitHub Actions enabled in your repository (forked). Got to
+**Settings** -> **Actions** -> **General** -> **Actions Permissions**; make sure
+you have checked the correct options.
+
+
+<!-- Links -->
+
+[SBCL]: https://www.sbcl.org/
+[Quicklisp]: https://www.quicklisp.org/beta/
+
+[Make]: https://www.gnu.org/software/make/

docs/content/Contributing/Developing-Qob/_index.zh-tw.md

@@ -0,0 +1,43 @@
+---
+title: 🔨 開發 Qob
+weight: 20
+---
+
+{{< toc >}}
+
+### 🚩 必備條件
+
+要更改 Qob，您應該：
+
+1. [SBCL][] 為 lisp 實作。
+2. [Make][] 用於編譯系統。
+3. [Quicklisp][] 為 CL 套件管理員。
+
+### 📝 建構
+
+若要建立開發環境，您必須使用 [build from source](https://cl-qob.github.io/Getting-Started/Install-Qob/#-build-from-source)
+方法安裝 Qob。請確定您已設定環境 PATH 變數，因此您可以從終端機呼叫 `qob`。
+
+完成安裝後，嘗試：
+
+```sh
+$ qob locate
+```
+
+它應該會列印出 `qob` 可執行檔的位置。即使您已安裝多個 Qob 版本，也應該可以辨識 Qob 可執行檔的位置！
+
+### 📈 測試
+
+Qob 不提供本地測試，我們所有的測試都是使用 GitHub 完成的動作。 請 fork 我們的存儲庫
+並將您的更改推送到您的 fork。 GitHub 行動應該為你拿起測試！
+
+確保您的存儲庫（分叉）中啟用了 GitHub Actions。 必須 **設置** -> **操作** -> **常規**
+-> **操作權限**； 確保您已經檢查了正確的選項。
+
+
+<!-- Links -->
+
+[SBCL]: https://www.sbcl.org/
+[Quicklisp]: https://www.quicklisp.org/beta/
+
+[Make]: https://www.gnu.org/software/make/

docs/content/Contributing/_index.en.md

@@ -0,0 +1,4 @@
+---
+title: Contributing
+weight: 500
+---

docs/content/Contributing/_index.zh-tw.md

@@ -0,0 +1,4 @@
+---
+title: 貢獻
+weight: 500
+---

docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md

@@ -12,7 +12,7 @@ Eask 的 CLI 功能齊全但易於使用，即使對於那些使用命令行的
 一旦你安裝了 [Eask]()，確保它在你的 `PATH` 中。 您可以通過 help 命令測試 Eask 是否已正確安裝：
 
 ```
-$ eask --help
+$ qob --help
 ```
 
 {{< hint ok >}}

docs/content/Getting-Started/Install-Qob/_index.en.md

@@ -3,15 +3,15 @@ title: 💾 Install Qob
 weight: 200
 ---
 
-This document guides you through the installation of Eask.
+This document guides you through the installation of Qob.
 
 Install Qob on macOS, Linux, Windows, BSD, and on any machine that can run the [Node.js][].
 
 {{< toc >}}
 
 ## 💾 Prebuilt binaries
 
-Download the appropriate version for your platform from [Eask Releases](https://github.com/emacs-eask/cli/releases).
+Download the appropriate version for your platform from [Qob Releases](https://github.com/cl-qob/cli/releases).
 Once downloaded, the binary can be run from anywhere. You don’t need to install
 it in a global location. This works well for shared hosts and other systems
 where you don’t have a privileged account.
@@ -24,43 +24,34 @@ is the most probable location.
 On macOS or Linux:
 
 ```sh
-$ curl -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.sh | sh
+$ curl -fsSL https://raw.githubusercontent.com/cl-qob/cli/master/webinstall/install.sh | sh
 ```
 
 On Windows:
 
 ```sh
-$ curl.exe -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.bat | cmd /Q
+$ curl.exe -fsSL https://raw.githubusercontent.com/cl-qob/cli/master/webinstall/install.bat | cmd /Q
 ```
 
 ## 💾 Package managers
 
-### 📦 npm (Cross-platform)
-
-If you have [npm][] installed on your machine, you can
-install Eask with the following one-liner:
-
-```sh
-$ npm install -g @emacs-eask/cli
-```
-
 ### 📦 Homebrew (macOS or Linux)
 
 [Homebrew][] is a free and open-source package manager for macOS and Linux.
-To install the Eask CLI:
+To install the Qob CLI:
 
 ```sh
-$ brew tap emacs-eask/cli https://github.com/emacs-eask/packaging
-$ brew install eask-cli
+$ brew tap cl-qob/cli https://github.com/cl-qob/packaging
+$ brew install qob-cli
 ```
 
 ### 📦 MacPorts (macOS)
 
 [MacPorts][] is a free and open-source package manager for macOS.
-To install the Eask CLI:
+To install the Qob CLI:
 
 ```sh
-$ sudo port install eask-cli
+$ sudo port install qob-cli
 ```
 
 ### 📦 Debian (Linux)
@@ -70,13 +61,13 @@ Derivatives of the [Debian][] distribution of Linux include [elementary OS][],
 [Ubuntu][], [Zorin OS][], and others.
 
 ```sh
-$ sudo curl -SsL -o /etc/apt/trusted.gpg.d/easksource.gpg https://raw.githubusercontent.com/emacs-eask/packaging/master/debian/KEY.gpg
-$ sudo curl -SsL -o /etc/apt/sources.list.d/easksource.list https://raw.githubusercontent.com/emacs-eask/packaging/master/debian/easksource.list
+$ sudo curl -SsL -o /etc/apt/trusted.gpg.d/qobsource.gpg https://raw.githubusercontent.com/cl-qob/packaging/master/debian/KEY.gpg
+$ sudo curl -SsL -o /etc/apt/sources.list.d/qobsource.list https://raw.githubusercontent.com/cl-qob/packaging/master/debian/qobsource.list
 $ sudo apt update --allow-insecure-repositories
-$ sudo apt install eask-cli --allow-unauthenticated
+$ sudo apt install qob-cli --allow-unauthenticated
 ```
 
-You can also download Debian packages from the [packaging][] repo.
+You can also download Debian packages from the [packaging][packaging/debian] repo.
 
 ### 📦 Snap (Linux)
 
@@ -85,12 +76,12 @@ Available for most distributions, snap packages are simple to install and are
 automatically updated.
 
 ```sh
-$ sudo snap install eask-cli
+$ sudo snap install qob-cli
 ```
 
 ### 📦 Arch (Linux)
 
-There's a `PKGBUILD` that builds `eask` from sources and creates a package, so
+There's a `PKGBUILD` that builds `qob` from sources and creates a package, so
 inside the top directory of the repository you can simply run:
 
 ```sh
@@ -100,104 +91,76 @@ $ makepkg -i
 ### 📦 Chocolatey (Windows)
 
 If you have [Chocolatey][] installed on your machine, you can
-install Eask with the following one-liner:
+install Qob with the following one-liner:
 
 ```sh
-$ choco install eask-cli
+$ choco install qob-cli
 ```
 
 ### 📦 Scoop (Windows)
 
 [Scoop][] is a free and open-source package manager for Windows.
-To install the Eask CLI:
+To install the Qob CLI:
 
 ```sh
-$ scoop bucket add emacs-eask/cli https://github.com/emacs-eask/packaging
-$ scoop install eask-cli
+$ scoop bucket add cl-qob/cli https://github.com/cl-qob/packaging
+$ scoop install qob-cli
 ```
 
 ### 📦 Winget (Windows)
 
 [Winget][] is Microsoft’s official free and open-source package manager for Windows.
-To install the Eask CLI:
+To install the Qob CLI:
 
 ```
-$ winget install eask.cli
+$ winget install qob.cli
 ```
 
 ## 💾 Build from source
 
 ### 🚩 Prerequisite Tools
 
-* [Git][]
-* [Node.js][]
-* [npm][]
+- [Git][]
+- [SBCL][]
+- [Quicklisp][]
 
 Alternatively, you can clone it directly from this repo
 
 ```sh
 # clone the repo
-$ git clone https://github.com/emacs-eask/cli eask-cli
+$ git clone https://github.com/cl-qob/cli qob-cli
 
-# change the working directory to eask-cli
-$ cd eask-cli
+# change the working directory to qob-cli
+$ cd qob-cli
 
-# install the requirements
-$ npm install
+# build executable to `bin` folder
+$ make build
 ```
 
-### 🏡 Setup (through script)
+### 🏡 Setup (through executable)
 
-You can now run `eask` using the script `bin/eask`; add `/path/to/eask-cli/bin/`
-to your environment `PATH` to execute eask from any location!
+You can now run `qob` using the executable `bin/qob`; add `/path/to/qob-cli/bin/`
+to your environment `PATH` to execute qob from any location!
 
 On Linux/macOS,
 
 ```sh
-export PATH="path/to/eask/bin:$PATH"
+export PATH="path/to/qob-cli/bin:$PATH"
 ```
 
 On Windows,
 
 ```batch
-set PATH=%PATH%;c:/path/to/eask/bin
+set PATH=%PATH%;c:/path/to/qob-cli/bin
 ```
 
-Once you have set it up correctly, try `eask --version` then you should see
-the current `eask`'s version number! 🎉 🎊
-
-### 🏡 Setup (through executable)
-
-To run `eask` through executable, you will need [pkg][] installed on your machine.
-
-```sh
-# install it locally in the workspace scope
-$ npm install --dev
-
-# or
-
-# install it globally
-$ npm install -g pkg
-```
-
-Subsequently, run the following command to build the executable.
-By default, it will generate an executable in the `dist` folder.
-
-```sh
-# build from sources. For available targets see `scripts` in `package.json`
-$ npm run pkg-linux-x64
-
-# move `lisp` to `dist` folder
-mv lisp dist
-```
-
-You can now run `eask` using the executable `dist/eask`; add `/path/to/eask-cli/dist/`
-to your environment `PATH` to execute eask from any location! 🎉 🎊
+Once you have set it up correctly, try `qob --version` then you should see
+the current `qob`'s version number! 🎉 🎊
 
 
 <!-- Links -->
 
-[packaging]: https://github.com/emacs-eask/packaging/tree/master/debian
+[packaging/debian]: https://github.com/cl-qob/packaging/tree/master/debian
 
 [Homebrew]: https://brew.sh/
 [MacPorts]: https://www.macports.org/
@@ -207,10 +170,8 @@ to your environment `PATH` to execute eask from any location! 🎉 🎊
 [Winget]: https://learn.microsoft.com/en-us/windows/package-manager/
 
 [Git]: https://git-scm.com/
-[Node.js]: https://nodejs.org/en/
-[npm]: https://www.npmjs.com/
-
-[pkg]: https://github.com/vercel/pkg
+[SBCL]: https://www.sbcl.org/
+[Quicklisp]: https://www.quicklisp.org/beta/
 
 [Debian]: https://www.debian.org/
 [elementary OS]: https://elementary.io/