diff --git a/docs/content/Getting-Started/Quick-Start/_index.en.md b/docs/content/Getting-Started/Quick-Start/_index.en.md index b57c303..6539eeb 100644 --- a/docs/content/Getting-Started/Quick-Start/_index.en.md +++ b/docs/content/Getting-Started/Quick-Start/_index.en.md @@ -8,40 +8,32 @@ weight: 100 Using Qob as your Lisp system management tool. {{< hint info >}} -The installation are cross-platform, using [npm](https://www.npmjs.com/). -For instructions about how to install Eask with other methods, see [install](https://emacs-eask.github.io/Getting-Started/Install-Eask/). +The installation are not cross-platform, using [npm](https://www.npmjs.com/). +For instructions about how to install Qob with other methods, see +[install](https://cl-qob.github.io/Getting-Started/Install-Qob/). It is required to have [Git installed](https://git-scm.com/downloads) to run this tutorial. {{< /hint >}} -## Step 1: Setup NodeJS runtime and `npm` +## Step 1: Download prebuilt binary -Please check out their official site -[here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm) -and install `NodeJS` and `npm` corresponds to your current operating system +See the [Prebuilt binaries](https://cl-qob.github.io/Getting-Started/Install-Qob/#-prebuilt-binaries) section. {{< hint ok >}} -💡 If you don't prefer **NodeJS** and **npm**, you can install with [binary](https://emacs-eask.github.io/Getting-Started/Install-Eask/#binary-cross-platform) -from our [release](https://github.com/emacs-eask/cli/releases) page. +💡 If you encounter any issue, try [Build from source](https://cl-qob.github.io/Getting-Started/Install-Qob/#-build-from-source). {{< /hint >}} -## Step 2: Install Eask - -```sh -$ npm install -g @emacs-eask/cli -``` - To verify your new installation: ```sh -$ eask --version +$ qob --version ``` -## Step 3: Navigate to an existing project or create a new project +## Step 2: Navigate to an existing project or create a new project -If you already have an existing elisp project, navigate to the project root -folder. +If you already have an existing common lisp project, navigate to the project +root folder. ```sh $ cd /path/to/project/dir/ @@ -50,77 +42,38 @@ $ cd /path/to/project/dir/ To create one: ```sh -$ eask create package project-name +$ qob create cl-project ``` -It should create a folder named `project-name` in your current working directory. - -## Step 4: Create `Eask`-file +It should create a folder named `` in your current working directory. -Skip this step if you chose to create the project with **`eask create`**! +## Step 4: Create `Qob`-file -Otherwise, to create Eask-file in the existing project: +Then, to create Qob-file in the project: ```sh -$ eask init +$ qob init ``` -You will be asked some questions about the package you are going to create: - -``` -package name: (your-project) -version: (1.0.0) -description: Your project description! -entry point: (your-project.el) -emacs version: (26.1) -website: https://example.com/project-url/ -keywords: tools example -About to write to /path/to/project/Eask: - -(package "your-project" - "1.0.0" - "Your project description!") - -(website-url "https://example.com/project-url/") -(keywords "tools" "example") - -(package-file "your-project.el") - -(script "test" "echo \"Error: no test specified\" && exit 1") - -(source "gnu") - -(depends-on "emacs" "26.1") - - -Is this OK? (yes) yes ⏎ -``` - -You should be able to see an `Eask` file in your project folder. 🎉🎊 +You should be able to see an `Qob` file in your project folder. 🎉🎊 ## Step 5: Start the package development To check your package information, run: ```sh -$ eask info +$ qob info ``` You should be able to see the following information: ``` -your-package (1.0.0) | deps: 0 | devDeps: 0 +your-package (1.0.0) | deps: 0 Your project description! https://example.com/project-url/ -keywords: tools, example - -entry: your-package-file.el -kind: single - -dist -.total-files: 0 -.unpacked-size: 0 +Author: Your Name +License: MIT ``` From the start, you would not have any `dependencies` and `devDependencies` (`0` by default)! diff --git a/docs/content/Getting-Started/Quick-Start/_index.zh-tw.md b/docs/content/Getting-Started/Quick-Start/_index.zh-tw.md index 017ee92..33ff609 100644 --- a/docs/content/Getting-Started/Quick-Start/_index.zh-tw.md +++ b/docs/content/Getting-Started/Quick-Start/_index.zh-tw.md @@ -14,29 +14,21 @@ weight: 100 需要安裝 [Git](https://git-scm.com/downloads) 才能運行本教程。 {{< /hint >}} -## 步驟 1: 設置 NodeJS runtime 和 `npm` +## 步驟 1: 下載預先建立的檔案 -請在 [此處](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and- npm) -並安裝 `NodeJS` 和 `npm` 對應你當前的操作系統 +請參閱[預建置檔案](https://cl-qob.github.io/Getting-Started/Install-Qob/#-prebuilt-binaries)部分。 {{< hint ok >}} -💡 如果您不喜歡 **NodeJS** 和 **npm**,您可以使用 [binary](https://emacs-eask.github.io/Getting-Started/Install-Eask/#binary-cross -platform) -來自我們的 [release](https://github.com/emacs-eask/cli/releases) 頁面。 +💡 如果遇到任何問題,請嘗試 [從原始碼建立](https://cl-qob.github.io/Getting-Started/Install-Qob/#-build-from-source)。 {{< /hint >}} -## 步驟 2: 安裝 Eask +驗證您的新安裝: ```sh -$ npm install -g @emacs-eask/cli +$ qob --version ``` -要驗證您的新安裝: - -```sh -$ eask --version -``` - -## 步驟 3: 導航到現有項目或創建新項目 +## 步驟 2: 導航到現有項目或創建新項目 如果您已有一個現有的 elisp 項目,請導航到項目根文件夾。 @@ -47,77 +39,38 @@ $ cd /path/to/project/dir/ 創建一個: ```sh -$ eask create package project-name +$ eask create package ``` -它應該在您當前的工作目錄中創建一個名為 `project-name` 的文件夾。 - -## 步驟 4: 創建 `Eask` 文件 +它應該在您當前的工作目錄中創建一個名為 `` 的文件夾。 -如果您選擇使用 **`eask create`** 創建項目,請跳過此步驟! +## 步驟 4: 創建 `Qob` 文件 -否則,在現有項目中創建 Eask 文件: +接著創建項目中創建 Qob 文件: ```sh -$ eask init +$ qob init ``` -您將被問到一些關於您將要創建的包的問題: - -``` -package name: (your-project) -version: (1.0.0) -description: Your project description! -entry point: (your-project.el) -emacs version: (26.1) -website: https://example.com/project-url/ -keywords: tools example -About to write to /path/to/project/Eask: - -(package "your-project" - "1.0.0" - "Your project description!") - -(website-url "https://example.com/project-url/") -(keywords "tools" "example") - -(package-file "your-project.el") - -(script "test" "echo \"Error: no test specified\" && exit 1") - -(source "gnu") - -(depends-on "emacs" "26.1") - - -Is this OK? (yes) yes ⏎ -``` - -您應該能夠在項目文件夾中看到一個 `Eask` 文件。 🎉🎊 +您應該能夠在項目文件夾中看到一個 `Qob` 文件。 🎉🎊 ## 步驟 5: 開始包開發 要檢查您的包裹信息,請運行: ```sh -$ eask info +$ qob info ``` 您應該能夠看到以下信息: ``` -your-package (1.0.0) | deps: 0 | devDeps: 0 +your-package (1.0.0) | deps: 0 Your project description! https://example.com/project-url/ -keywords: tools, example - -entry: your-package-file.el -kind: single - -dist -.total-files: 0 -.unpacked-size: 0 +Author: Your Name +License: MIT ``` 從一開始,您就不會有任何 `dependencies` 和 `devDependencies`(默認為 `0`)!