mirror of
https://github.com/RubyMetric/chsrc
synced 2025-07-13 01:42:51 +08:00
Update doc
This commit is contained in:
parent
54a93f9e19
commit
a2851d5246
15
README.md
15
README.md
@ -4,10 +4,10 @@
|
||||
! Doc Type : Markdown
|
||||
! Doc Name : README.md
|
||||
! Doc Authors : Aoran Zeng <ccmywish@qq.com>
|
||||
! Contributors : Nul None <nul@none.org>
|
||||
! Contributors : Mikachu2333 <mikachu.23333@zohomail.com>
|
||||
! |
|
||||
! Created On : <2023-12-28>
|
||||
! Last Modified : <2025-06-18>
|
||||
! Last Modified : <2025-06-19>
|
||||
! ---------------------------------------------------------- -->
|
||||
|
||||
<div align="center">
|
||||
@ -39,13 +39,18 @@
|
||||
|
||||
> [!TIP]
|
||||
> **`chsrc` 不仅是一个命令行工具,同时也是一个体现了 Ruby on Rails 思想的 MVC 换源框架,它甚至使你能够在不了解C语言的情况下编写出新的换源方法(recipe)。** [Write A Recipe Even If You Don't Know C](./doc/02-Write-A-Recipe-Even-If-You-Dont-Know-C.md)
|
||||
|
||||
---
|
||||
|
||||
> [!NOTE]
|
||||
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助**。欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者参与贡献。[从开发到提交贡献,我们覆盖全流程文档](./doc/)
|
||||
,另外作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)
|
||||
> 这是你可以参与的第一个现实世界中有用的C语言项目!不再是枯燥的数据结构习题,不用再面对二十年前古老界面的 **Dev-C++**,[用 VS Code 一分钟内搭建环境编译、运行、测试、Debug chsrc !](./doc/01-Develop.md)
|
||||
>
|
||||
> 欢迎对 GitHub、Gitee 协作不熟悉的人以此为契机学习参与贡献, 欢迎任何编程初学者。[从开发到提交PR,我们覆盖全流程文档](./doc/)
|
||||
,作者可提供一定的 [贡献指导](https://github.com/RubyMetric/chsrc/discussions/50)
|
||||
---
|
||||
|
||||
> [!IMPORTANT]
|
||||
> [招募 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
|
||||
> **`chsrc` 可换源 60+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者!](https://github.com/RubyMetric/chsrc/issues/130)
|
||||
|
||||
<br>
|
||||
|
||||
|
@ -7,14 +7,28 @@
|
||||
! Contributors : Nul None <nul@none.org>
|
||||
! |
|
||||
! Created On : <2024-12-27>
|
||||
! Last Modified : <2025-03-06>
|
||||
! Last Modified : <2025-06-19>
|
||||
! ---------------------------------------------------------- -->
|
||||
|
||||
# 开发
|
||||
|
||||
## 环境
|
||||
## 开发环境
|
||||
|
||||
请安装好 `GCC` 或 `Clang` 和 `make` 以及 `curl`
|
||||
请安装好:
|
||||
|
||||
1. `GCC` 或 `Clang`
|
||||
2. [just] 或 `make`
|
||||
3. `curl`
|
||||
|
||||
**我推荐你使用 VS Code 开发,你可以在一分钟内成功编译、运行和 Debug `chsrc`**
|
||||
|
||||
1. `Ctrl-Shift-B` 直接构建
|
||||
2. `F5` 直接开始 Debug
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
## 准备
|
||||
|
||||
```bash
|
||||
# 请务必使用 dev 分支开发
|
||||
@ -25,6 +39,7 @@ $ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
## 编译运行
|
||||
|
||||
```bash
|
||||
@ -63,3 +78,5 @@ make clean
|
||||
关于分支的说明以及如何提交代码,请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)
|
||||
|
||||
<br>
|
||||
|
||||
[just]: https://github.com/casey/just
|
||||
|
@ -9,7 +9,7 @@
|
||||
.\" Last Modified : <2025-06-16>
|
||||
.\" --------------------------------------------------------------
|
||||
|
||||
.TH chsrc 1 "2025-06-16" "v0.2.1.1" "RubyMetric chsrc"
|
||||
.TH chsrc 1 "2025-06-16" "v0.2.1.2" "RubyMetric chsrc"
|
||||
|
||||
.SH NAME
|
||||
chsrc - Change Source for every software on every platform from the command line
|
||||
|
@ -6,15 +6,15 @@
|
||||
@c Contributors : Nul None <nul@none.org>
|
||||
@c |
|
||||
@c Created On : <2024-08-22>
|
||||
@c Last Modified : <2024-10-09>
|
||||
@c Last Modified : <2025-06-19>
|
||||
@c --------------------------------------------------------------
|
||||
|
||||
\input texinfo
|
||||
@setfilename chsrc.info
|
||||
@settitle chsrc
|
||||
|
||||
@set Chsrc_Version v0.1.9
|
||||
@set Doc_Publish_Date 2024-10-09
|
||||
@set Chsrc_Version v0.2.1.2
|
||||
@set Doc_Publish_Date 2025-06-19
|
||||
|
||||
@copying
|
||||
@comment 这是软件copyright,不是文档copyright,因此不放在titlepage
|
||||
|
Loading…
x
Reference in New Issue
Block a user