Skip to content

Commit d372779

Browse files
jcs090218jcs090218
committed
docs: in process
1 parent e78c195 commit d372779

File tree

2 files changed

+36
-130
lines changed

2 files changed

+36
-130
lines changed

‎docs/content/Getting-Started/Quick-Start/_index.en.md

Lines changed: 20 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,32 @@ weight: 100
88
Using Qob as your Lisp system management tool.
99

1010
{{< hint info >}}
11-
The installation are cross-platform, using [npm](https://www.npmjs.com/).
12-
For instructions about how to install Eask with other methods, see [install](https://emacs-eask.github.io/Getting-Started/Install-Eask/).
11+
The installation are not cross-platform, using [npm](https://www.npmjs.com/).
12+
For instructions about how to install Qob with other methods, see
13+
[install](https://cl-qob.github.io/Getting-Started/Install-Qob/).
1314

1415
It is required to have [Git installed](https://git-scm.com/downloads)
1516
to run this tutorial.
1617
{{< /hint >}}
1718

18-
## Step 1: Setup NodeJS runtime and `npm`
19+
## Step 1: Download prebuilt binary
1920

20-
Please check out their official site
21-
[here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm)
22-
and install `NodeJS` and `npm` corresponds to your current operating system
21+
See the [Prebuilt binaries](https://cl-qob.github.io/Getting-Started/Install-Qob/#-prebuilt-binaries) section.
2322

2423
{{< hint ok >}}
25-
💡 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)
26-
from our [release](https://github.com/emacs-eask/cli/releases) page.
24+
💡 If you encounter any issue, try [Build from source](https://cl-qob.github.io/Getting-Started/Install-Qob/#-build-from-source).
2725
{{< /hint >}}
2826

29-
## Step 2: Install Eask
30-
31-
```sh
32-
$ npm install -g @emacs-eask/cli
33-
```
34-
3527
To verify your new installation:
3628

3729
```sh
38-
$ eask --version
30+
$ qob --version
3931
```
4032

41-
## Step 3: Navigate to an existing project or create a new project
33+
## Step 2: Navigate to an existing project or create a new project
4234

43-
If you already have an existing elisp project, navigate to the project root
44-
folder.
35+
If you already have an existing common lisp project, navigate to the project
36+
root folder.
4537

4638
```sh
4739
$ cd /path/to/project/dir/
@@ -50,77 +42,38 @@ $ cd /path/to/project/dir/
5042
To create one:
5143

5244
```sh
53-
$ eask create package project-name
45+
$ qob create cl-project <your-project>
5446
```
5547

56-
It should create a folder named `project-name` in your current working directory.
57-
58-
## Step 4: Create `Eask`-file
48+
It should create a folder named `<your-project>` in your current working directory.
5949

60-
Skip this step if you chose to create the project with **`eask create`**!
50+
## Step 4: Create `Qob`-file
6151

62-
Otherwise, to create Eask-file in the existing project:
52+
Then, to create Qob-file in the project:
6353

6454
```sh
65-
$ eask init
55+
$ qob init
6656
```
6757

68-
You will be asked some questions about the package you are going to create:
69-
70-
```
71-
package name: (your-project)
72-
version: (1.0.0)
73-
description: Your project description!
74-
entry point: (your-project.el)
75-
emacs version: (26.1)
76-
website: https://example.com/project-url/
77-
keywords: tools example
78-
About to write to /path/to/project/Eask:
79-
80-
(package "your-project"
81-
"1.0.0"
82-
"Your project description!")
83-
84-
(website-url "https://example.com/project-url/")
85-
(keywords "tools" "example")
86-
87-
(package-file "your-project.el")
88-
89-
(script "test" "echo \"Error: no test specified\" && exit 1")
90-
91-
(source "gnu")
92-
93-
(depends-on "emacs" "26.1")
94-
95-
96-
Is this OK? (yes) yes ⏎
97-
```
98-
99-
You should be able to see an `Eask` file in your project folder. 🎉🎊
58+
You should be able to see an `Qob` file in your project folder. 🎉🎊
10059

10160
## Step 5: Start the package development
10261

10362
To check your package information, run:
10463

10564
```sh
106-
$ eask info
65+
$ qob info
10766
```
10867

10968
You should be able to see the following information:
11069

11170
```
112-
your-package (1.0.0) | deps: 0 | devDeps: 0
71+
your-package (1.0.0) | deps: 0
11372
Your project description!
11473
https://example.com/project-url/
11574
116-
keywords: tools, example
117-
118-
entry: your-package-file.el
119-
kind: single
120-
121-
dist
122-
.total-files: 0
123-
.unpacked-size: 0
75+
Author: Your Name
76+
License: MIT
12477
```
12578

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

‎docs/content/Getting-Started/Quick-Start/_index.zh-tw.md

Lines changed: 16 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,21 @@ weight: 100
1414
需要安裝 [Git](https://git-scm.com/downloads) 才能運行本教程。
1515
{{< /hint >}}
1616

17-
## 步驟 1: 設置 NodeJS runtime 和 `npm`
17+
## 步驟 1: 下載預先建立的檔案
1818

19-
請在 [此處](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and- npm)
20-
並安裝 `NodeJS` 和 `npm` 對應你當前的操作系統
19+
請參閱[預建置檔案](https://cl-qob.github.io/Getting-Started/Install-Qob/#-prebuilt-binaries)部分。
2120

2221
{{< hint ok >}}
23-
💡 如果您不喜歡 **NodeJS** 和 **npm**，您可以使用 [binary](https://emacs-eask.github.io/Getting-Started/Install-Eask/#binary-cross -platform）
24-
來自我們的 [release](https://github.com/emacs-eask/cli/releases) 頁面。
22+
💡 如果遇到任何問題，請嘗試 [從原始碼建立](https://cl-qob.github.io/Getting-Started/Install-Qob/#-build-from-source)。
2523
{{< /hint >}}
2624

27-
## 步驟 2: 安裝 Eask
25+
驗證您的新安裝：
2826

2927
```sh
30-
$ npm install -g @emacs-eask/cli
28+
$ qob --version
3129
```
3230

33-
要驗證您的新安裝：
34-
35-
```sh
36-
$ eask --version
37-
```
38-
39-
## 步驟 3: 導航到現有項目或創建新項目
31+
## 步驟 2: 導航到現有項目或創建新項目
4032

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

@@ -47,77 +39,38 @@ $ cd /path/to/project/dir/
4739
創建一個：
4840

4941
```sh
50-
$ eask create package project-name
42+
$ eask create package <your-project>
5143
```
5244

53-
它應該在您當前的工作目錄中創建一個名為 `project-name` 的文件夾。
54-
55-
## 步驟 4： 創建 `Eask` 文件
45+
它應該在您當前的工作目錄中創建一個名為 `<your-project>` 的文件夾。
5646

57-
如果您選擇使用 **`eask create`** 創建項目，請跳過此步驟！
47+
## 步驟 4： 創建 `Qob` 文件
5848

59-
否則，在現有項目中創建 Eask 文件：
49+
接著創建項目中創建 Qob 文件：
6050

6151
```sh
62-
$ eask init
52+
$ qob init
6353
```
6454

65-
您將被問到一些關於您將要創建的包的問題：
66-
67-
```
68-
package name: (your-project)
69-
version: (1.0.0)
70-
description: Your project description!
71-
entry point: (your-project.el)
72-
emacs version: (26.1)
73-
website: https://example.com/project-url/
74-
keywords: tools example
75-
About to write to /path/to/project/Eask:
76-
77-
(package "your-project"
78-
"1.0.0"
79-
"Your project description!")
80-
81-
(website-url "https://example.com/project-url/")
82-
(keywords "tools" "example")
83-
84-
(package-file "your-project.el")
85-
86-
(script "test" "echo \"Error: no test specified\" && exit 1")
87-
88-
(source "gnu")
89-
90-
(depends-on "emacs" "26.1")
91-
92-
93-
Is this OK? (yes) yes ⏎
94-
```
95-
96-
您應該能夠在項目文件夾中看到一個 `Eask` 文件。 🎉🎊
55+
您應該能夠在項目文件夾中看到一個 `Qob` 文件。 🎉🎊
9756

9857
## 步驟 5: 開始包開發
9958

10059
要檢查您的包裹信息，請運行：
10160

10261
```sh
103-
$ eask info
62+
$ qob info
10463
```
10564

10665
您應該能夠看到以下信息：
10766

10867
```
109-
your-package (1.0.0) | deps: 0 | devDeps: 0
68+
your-package (1.0.0) | deps: 0
11069
Your project description!
11170
https://example.com/project-url/
11271
113-
keywords: tools, example
114-
115-
entry: your-package-file.el
116-
kind: single
117-
118-
dist
119-
.total-files: 0
120-
.unpacked-size: 0
72+
Author: Your Name
73+
License: MIT
12174
```
12275

12376
從一開始，您就不會有任何 `dependencies` 和 `devDependencies`（默認為 `0`）！

0 commit comments

Comments
 (0)