Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 committed Nov 19, 2024
1 parent 24b1b68 commit 60f9e6f
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 77 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ a directory with the following structure:
└─ main.lisp
```

## Directory Structure Explained
## 📂 Directory Structure Explained

See https://github.com/fukamachi/cl-project for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ weight: 350
└─ main.lisp
```

## 目錄結構說明
## 📂 目錄結構說明

如需詳細資訊,請參閱 https://github.com/fukamachi/cl-project。
83 changes: 46 additions & 37 deletions docs/content/Getting-Started/Quick-Start/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,11 @@ weight: 100
Using Qob as your Lisp system management tool.

{{< hint info >}}
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: Download prebuilt binary
## 🔍 Step 1: Download prebuilt binary

See the [Prebuilt binaries](https://cl-qob.github.io/Getting-Started/Install-Qob/#-prebuilt-binaries) section.

Expand All @@ -30,7 +26,7 @@ To verify your new installation:
$ qob --version
```

## Step 2: 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 common lisp project, navigate to the project
root folder.
Expand All @@ -47,7 +43,7 @@ $ qob create cl-project <your-project>

It should create a folder named `<your-project>` in your current working directory.

## Step 4: Create `Qob`-file
## 🔍 Step 3: Create `Qob`-file

Then, to create Qob-file in the project:

Expand All @@ -57,7 +53,7 @@ $ qob init

You should be able to see an `Qob` file in your project folder. 🎉🎊

## Step 5: Start the package development
## 🔍 Step 4: Start the package development

To check your package information, run:

Expand All @@ -76,59 +72,72 @@ Author: Your Name
License: MIT
```

From the start, you would not have any `dependencies` and `devDependencies` (`0` by default)!
From the start, you would not have any `dependencies` (`0` by default)!

## Step 6: Manage package archives
## 🔍 Step 5: Manage system dist

You can manage package archives by using the `source` directive in your **Eask**-file.
You can manage dist by using the `source` directive in your **Qob**-file.

```elisp
(source "gnu") ; default
(source "melpa") ; Add package archives
```cl
(source "quicklisp") ; default dist
(source "ultralisp") ; Addition dist
```

{{< hint info >}}
💡 See [DSL/source](https://emacs-eask.github.io/DSL/#-source-alias) for more information!
💡 See [DSL/source](https://cl-qob.github.io/DSL/#-source-alias) for more information!
{{< /hint >}}

## Step 7: Add some dependencies
## 🔍 Step 6: Add some dependencies

You can now add dependencies in your ASD file.

You can add dependencies by using `depends-on` directive in your **Eask**-file.
```cl
(defsystem "your-project"
...
:depends-on (flx str clingon) ; Add dependencies here!
...
```

```elisp
You can add local dependencies by using `depends-on` directive in your **Qob**-file.

```cl
...
(depends-on "f")
(depends-on "ht")
(depends-on "fsdb" "https://github.com/billstclair/fsdb" :git)
```

{{< hint danger >}}
💡 Make sure the dependencies you add are available in the package archives!

Or else you would get an error **`package-name-' is unavailable**!
💡 Make sure the dependencies you add are available in one of those dist!
{{< /hint >}}

## Step 8: Install dependencies
## 🔍 Step 7: Install dependencies

Now we can install the dependencies we have specified in the **Eask**-file:
Now we can install the dependencies we have specified in **ASD** and **Qob** files:

```elisp
$ eask install-deps
```sh
$ qob install-deps
```

You should see Eask executed correctly with the similar output below:
You should see Qob executed correctly with the similar output below:

```
Loading package information... done
Installing 2 package dependencies...
- Installing f (20220405.1534)... done
- Installing ht (20210119.741)... done
Loading ASDF files... done ✓
Installing 1 system...
- [1/1] Installing fsdb from https://github.com/billstclair/fsdb... done ✓
(Total of 1 system installed; 0 skipped)
Installing 3 systems...
- [1/3] Installing flx (0)... done ✓
- [2/3] Installing str (0)... done ✓
- [3/3] Installing clingon (0)... done ✓
(Total of 2 dependencies installed, 0 skipped)
(Total of 3 systems installed; 0 skipped)
```

## See Also
## 🔗 See Also

- [Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/)
- [Domain Specific Language](https://emacs-eask.github.io/DSL/)
- [Basic Usage](https://emacs-eask.github.io/Getting-Started/Basic-Usage/)
- [Commands and options](https://cl-qob.github.io/Getting-Started/Commands-and-options/)
- [Domain Specific Language](https://cl-qob.github.io/DSL/)
- [Basic Usage](https://cl-qob.github.io/Getting-Started/Basic-Usage/)
86 changes: 48 additions & 38 deletions docs/content/Getting-Started/Quick-Start/_index.zh-tw.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@ weight: 100

{{< toc >}}

使用 Eask 作為您的 Emacs 包管理工具
使用 Qob 作為您的 Lisp 系統管理工具

{{< hint info >}}
安裝是跨平台的,使用 [npm](https://www.npmjs.com/)。 關於如何使用其他方法安裝 Eask 的說明,
請參見[安裝](https://emacs-eask.github.io/Getting-Started/Install-Eask/)

需要安裝 [Git](https://git-scm.com/downloads) 才能運行本教程。
{{< /hint >}}

## 步驟 1: 下載預先建立的檔案
## 🔍 步驟 1: 下載預先建立的檔案

請參閱[預建置檔案](https://cl-qob.github.io/Getting-Started/Install-Qob/#-prebuilt-binaries)部分。

Expand All @@ -28,7 +25,7 @@ weight: 100
$ qob --version
```

## 步驟 2: 導航到現有項目或創建新項目
## 🔍 步驟 2: 導航到現有項目或創建新項目

如果您已有一個現有的 elisp 項目,請導航到項目根文件夾。

Expand All @@ -39,12 +36,12 @@ $ cd /path/to/project/dir/
創建一個:

```sh
$ eask create package <your-project>
$ qob create cl-project <your-project>
```

它應該在您當前的工作目錄中創建一個名為 `<your-project>` 的文件夾。

## 步驟 4: 創建 `Qob` 文件
## 🔍 步驟 3: 創建 `Qob` 文件

接著創建項目中創建 Qob 文件:

Expand All @@ -54,7 +51,7 @@ $ qob init

您應該能夠在項目文件夾中看到一個 `Qob` 文件。 🎉🎊

## 步驟 5: 開始包開發
## 🔍 步驟 4: 開始包開發

要檢查您的包裹信息,請運行:

Expand All @@ -73,59 +70,72 @@ Author: Your Name
License: MIT
```

從一開始,您就不會有任何 `dependencies``devDependencies`(默認為 `0`)!
從一開始,您就不會有任何 `dependencies`(默認為 `0`)!

## 步驟 6: 管理包檔案
## 🔍 步驟 5: 管理系統 dist

您可以使用 **Eask** 文件中的 `source` 指令來管理包存檔
您可以使用 **Qob** 文件中的 `source` 指令來系統 dist

```elisp
(source "gnu") ; 默認
(source "melpa") ; 添加包 archive
```cl
(source "quicklisp") ; 默認 dist
(source "ultralisp") ; 新增 dist
```

{{< hint info >}}
💡 有關更多信息,請參閱 [DSL/source](https://emacs-eask.github.io/DSL/#-source-alias)
💡 有關更多信息,請參閱 [DSL/source](https://cl-qob.github.io/DSL/#-source-alias)
{{< /hint >}}

## 步驟 7: 添加一些依賴
## 🔍 步驟 6: 添加一些依賴

現在您可以在 ASD 檔案中加入依賴。

您可以在 **Eask** 文件中使用 `depends-on` 指令添加依賴項。
```cl
(defsystem "your-project"
...
:depends-on (flx str clingon) ; 在這新增依賴!
...
```

```elisp
您可以在 **Qob** 文件中使用 `depends-on` 指令添加當地依賴。

```cl
...
(depends-on "f")
(depends-on "ht")
(depends-on "fsdb" "https://github.com/billstclair/fsdb" :git)
```

{{< hint danger >}}
💡 確保您添加的依賴項在包存檔中可用!

否則你會得到一個錯誤 **`package-name-' is unavailable**
💡 確認您新增的相依性在其中一個 dist 中可用!
{{< /hint >}}

## 步驟 8: 安裝依賴
## 🔍 步驟 7: 安裝依賴

現在我們可以安裝我們在 **Eask** 文件中指定的依賴項:
現在我們可以安裝我們在 **ASD****Qob** 文件中指定的依賴項:

```elisp
$ eask install-deps
```sh
$ qob install-deps
```

您應該會看到 Eask 正確執行,輸出類似如下:
您應該會看到 Qob 正確執行,輸出類似如下:

```
Loading package information... done
Installing 2 package dependencies...
- Installing f (20220405.1534)... done
- Installing ht (20210119.741)... done
Loading ASDF files... done ✓
Installing 1 system...
- [1/1] Installing fsdb from https://github.com/billstclair/fsdb... done ✓
(Total of 1 system installed; 0 skipped)
Installing 3 systems...
- [1/3] Installing flx (0)... done ✓
- [2/3] Installing str (0)... done ✓
- [3/3] Installing clingon (0)... done ✓
(Total of 2 dependencies installed, 0 skipped)
(Total of 3 systems installed; 0 skipped)
```

## 也可以看看
## 🔗 也可以看看

- [Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/)
- [Domain Specific Language](https://emacs-eask.github.io/DSL/)
- [Basic Usage](https://emacs-eask.github.io/Getting-Started/Basic-Usage/)
- [Commands and options](https://cl-qob.github.io/Getting-Started/Commands-and-options/)
- [Domain Specific Language](https://cl-qob.github.io/DSL/)
- [Basic Usage](https://cl-qob.github.io/Getting-Started/Basic-Usage/)

0 comments on commit 60f9e6f

Please sign in to comment.