Skip to content

Commit 0477a13

Browse files
AnsurfenAnsurfen
committed
improve docs
1 parent 047585b commit 0477a13

6 files changed

Lines changed: 259 additions & 15 deletions

File tree

‎src/.vuepress/navbar/en.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export const enNavbar = navbar([
3333
},
3434
"/demos/",
3535
{
36-
text: "Others",
37-
icon: "circle-info",
36+
text: "Help & Support",
37+
icon: "circle-check",
3838
children: [
3939
{
4040
text: "PROJECT",

‎src/.vuepress/navbar/zh.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,36 +33,36 @@ export const zhNavbar = navbar([
3333
},
3434
"/zh/demos/",
3535
{
36-
text: "其他",
37-
icon: "circle-info",
36+
text: "帮助与支持",
37+
icon: "circle-check",
3838
children: [
3939
{
4040
text: "项目",
4141
children: [
4242
{
4343
text: "常见问题",
4444
icon: "circle-question",
45-
link: "/others/faq"
45+
link: "/zh/others/faq"
4646
},
4747
{
4848
text: "路线图",
4949
icon: "map",
50-
link: "/others/roadmap",
50+
link: "/zh/others/roadmap",
5151
},
5252
{
5353
text: "变更日志",
5454
icon: "clock",
55-
link: "/others/changelog",
55+
link: "/zh/others/changelog",
5656
},
5757
{
5858
text: "贡献指南",
5959
icon: "lightbulb",
60-
link: "/others/contribution",
60+
link: "/zh/others/contribution",
6161
},
6262
{
6363
text: "协议",
6464
icon: "paperclip",
65-
link: "/others/license"
65+
link: "/zh/others/license"
6666
}
6767
]
6868
}

‎src/others/license.md‎

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,97 @@
11
---
22
title: License
33
icon: paperclip
4-
---
4+
---
5+
6+
## Overview of Open Source License
7+
8+
Most Hulo projects use the MIT License, which means you are free to use, modify, and distribute Hulo's code, and the authors bear no liability for any issues arising from its use.
9+
10+
## Details of the MIT License
11+
12+
### Main Points
13+
14+
- **Freedom of Use**: You are free to use, modify, and distribute Hulo's code
15+
- **Commercial Friendly**: Can be used in commercial projects without fees
16+
- **Liability Disclaimer**: The authors bear no liability for any issues arising from the use of Hulo
17+
- **Copyright Notice**: You must retain the original copyright and license notice
18+
19+
### Specific Rights
20+
21+
✅ **Permitted Actions**:
22+
- Commercial use
23+
- Modification of source code
24+
- Distribution
25+
- Private use
26+
- Patent use
27+
28+
❌ **Limitations**:
29+
- The authors bear no liability
30+
- Copyright notice must be retained
31+
32+
## Policy for Rewritten Projects
33+
34+
For projects rewritten by Hulo, the Hulo project will adopt the same license as the original project to avoid unnecessary legal risks.
35+
36+
**Reasons**:
37+
- To avoid license conflicts
38+
- To respect the original project's open source license
39+
- To ensure legal compliance
40+
41+
## Full License Text
42+
43+
```
44+
MIT License
45+
46+
Copyright (c) 2025 Hulo
47+
48+
Permission is hereby granted, free of charge, to any person obtaining a copy
49+
of this software and associated documentation files (the "Software"), to deal
50+
in the Software without restriction, including without limitation the rights
51+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
52+
copies of the Software, and to permit persons to whom the Software is
53+
furnished to do so, subject to the following conditions:
54+
55+
The above copyright notice and this permission notice shall be included in all
56+
copies or substantial portions of the Software.
57+
58+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
59+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
60+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
61+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
62+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
63+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
64+
SOFTWARE.
65+
```
66+
67+
## Contributor Guide
68+
69+
### Contributor Agreement
70+
71+
When you contribute code to the Hulo project, you agree that:
72+
73+
1. Your contributions will be licensed under the MIT License
74+
2. You own or have the right to grant these rights
75+
3. Your contributions do not infringe on any third-party rights
76+
77+
### Third-Party Dependencies
78+
79+
Hulo projects may include third-party dependencies, which may have their own licenses. Please refer to the license files of each dependency for details.
80+
81+
## Contact & Changes
82+
83+
### Contact Information
84+
85+
If you have any questions about Hulo's license, please contact us via:
86+
87+
- GitHub Issues: [Project Repository](https://github.com/hulo-lang/hulo)
88+
- Email: [Contact Email]
89+
90+
### License Changes
91+
92+
If there are any changes to Hulo's license, we will:
93+
94+
1. Announce it in the project repository
95+
2. Update relevant documentation
96+
3. Notify major contributors
97+
4. Clearly indicate it in the release notes

‎src/zh/others/changelog.md‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
---
2-
title: Changelog
2+
title: 变更日记
33
icon: clock
4+
date: 2025-07-23
45
---
56

7+
## [v0.2.0]() - 2025-07-19
8+
9+
### Added
10+
11+
- Bash transpiler support
12+
- HLPM (Hulo Package Manager) commandline tool for managing Hulo packages
13+
- `init`, `install`, `uninstall`, `run` commands implemented
14+
- Package publishing and import resolution pending
15+
- Hulo-REPL commandline tool with simple completion and theme support
16+
- Basic completion and theme settings implemented
17+
- Full integration pending
18+
19+
### Fixed
20+
21+
- Fixed string translation issue with `echo "Hello World"` [#4](https://github.com/hulo-lang/hulo/issues/4)
22+
23+
### Breaking Changes
24+
25+
- Refactored VBScript transpiler - this is a breaking change, output may not be consistent with v0.1.0
26+
- Refactored Hulo commandline tool to read `huloc.yaml` configuration file from working directory
27+
28+
### Migration
29+
30+
- Environmental variable `HULOPATH` renamed to `HULO_PATH`
31+
32+
## [v0.1.0](https://github.com/hulo-lang/hulo/commit/c119ee825f518af1cb2a6fbe8012ed265970cbd2) - 2025-07-13
33+
34+
### Added
35+
36+
- First Release, only support VBScript

‎src/zh/others/faq.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,30 @@
11
---
2-
title: FAQ
2+
title: 常见问题
33
icon: circle-question
4-
---
4+
date: 2025-07-23
5+
6+
---
7+
8+
### 为什么要重新发明新语言？
9+
10+
因为翻译成批处理脚本最重要的就是命令类型，比如 `git clone xxx` 这种。现有的语言根本不支持这样的语法，所以一个新的语言就诞生了，命令就是最基础的数据类型。
11+
12+
### 既然 Windows 都自带 PowerShell 了，为什么还需要 Hulo？
13+
14+
虽然自带 PowerShell，但 Hulo 并不冲突。未来可以编写一个 Hulo 代码，翻译成 PowerShell 和 Bash 脚本，让批处理脚本一次编写多端运行。这还需要一个命令转换系统，比如 `Write-Host` 和 `echo` 的跨平台抽象。
15+
16+
### VBS 都要被废了，为什么还要支持？
17+
18+
虽然 VBS 要被废弃，但 Windows 10 还有很大市场份额。先发布 VBS 支持是因为它的语法最接近传统的编程语言，不会像其他批处理脚本一样有各种抽象的概念（比如 `&>`, `$()`, `[[]]` 等符号满天飞）。
19+
20+
### Hulo 设想的应用场景是什么？
21+
22+
目前的目标是 Hulo 能够重写如 nvm（基于 bash）、scoop（基于 powershell）这样的项目，以一种比较现代化语言的方式。
23+
24+
### 与同类项目相比有什么优势？
25+
26+
Hulo 与 Amber、Batsh、TypeShell 等项目的区别在于：
27+
28+
- 其他项目基本上是把命令当函数使唤，本质上和通用编程语言无异
29+
- Hulo 的解决方案是直接将命令当成基础数据类型，对 cmd 进行操作，cmd 就是 class 就是 interface
30+
- 这样设计能对命令进行代码提示和类型检测

‎src/zh/others/license.md‎

Lines changed: 96 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,98 @@
11
---
2-
title: License
2+
title: 协议
33
icon: paperclip
4-
---
4+
date: 2025-07-23
5+
---
6+
7+
## 开源协议概述
8+
9+
Hulo 的大部分项目均采用 MIT 协议，这意味着您可以自由使用、修改、分发 Hulo 的代码，同时作者不承担任何因使用 Hulo 而产生的责任。
10+
11+
## MIT 协议详解
12+
13+
### 主要内容
14+
15+
- **使用自由**：您可以自由使用、修改、分发 Hulo 的代码
16+
- **商业友好**：可以用于商业项目，无需支付费用
17+
- **责任豁免**：作者不承担任何因使用 Hulo 而产生的责任
18+
- **版权声明**：需要保留原始的版权声明和许可证声明
19+
20+
### 具体权利
21+
22+
✅ **允许的行为**：
23+
- 商业使用
24+
- 修改源代码
25+
- 分发软件
26+
- 私人使用
27+
- 专利使用
28+
29+
❌ **限制**：
30+
- 作者不承担任何责任
31+
- 必须保留版权声明
32+
33+
## 重写项目协议政策
34+
35+
在 Hulo 重写的项目中，Hulo 项目则采取和被重写的项目同样的协议以规避不必要的风险。
36+
37+
**原因**：
38+
- 避免协议冲突
39+
- 尊重原项目的开源协议
40+
- 确保法律合规性
41+
42+
## 完整协议文本
43+
44+
```
45+
MIT License
46+
47+
Copyright (c) 2025 Hulo
48+
49+
Permission is hereby granted, free of charge, to any person obtaining a copy
50+
of this software and associated documentation files (the "Software"), to deal
51+
in the Software without restriction, including without limitation the rights
52+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
53+
copies of the Software, and to permit persons to whom the Software is
54+
furnished to do so, subject to the following conditions:
55+
56+
The above copyright notice and this permission notice shall be included in all
57+
copies or substantial portions of the Software.
58+
59+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
60+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
61+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
62+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
63+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
64+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
65+
SOFTWARE.
66+
```
67+
68+
## 贡献者指南
69+
70+
### 贡献协议
71+
72+
当您向 Hulo 项目贡献代码时，您需要同意：
73+
74+
1. 您的贡献将采用 MIT 协议
75+
2. 您拥有或有权授予这些权利
76+
3. 您的贡献不侵犯任何第三方的权利
77+
78+
### 第三方依赖
79+
80+
Hulo 项目可能包含第三方依赖，这些依赖可能有自己的许可证。请查看各个依赖的许可证文件以了解详细信息。
81+
82+
## 联系与变更
83+
84+
### 联系信息
85+
86+
如果您对 Hulo 的许可证有任何疑问，请通过以下方式联系：
87+
88+
- GitHub Issues：[项目仓库](https://github.com/hulo-lang/hulo)
89+
- 邮箱：[联系邮箱]
90+
91+
### 许可证变更
92+
93+
如果 Hulo 的许可证发生变更，我们会：
94+
95+
1. 在项目仓库中发布公告
96+
2. 更新相关文档
97+
3. 通知主要贡献者
98+
4. 在发布说明中明确标注

0 commit comments

Comments
 (0)