docs: a simplified readme
This commit is contained in:
parent
5a48dd5657
commit
4163c52275
|
|
@ -0,0 +1,19 @@
|
|||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
contributors-readme-job:
|
||||
runs-on: ubuntu-latest
|
||||
name: A job to automate contrib in readme
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Contribute List
|
||||
uses: akhilmhdh/contributors-readme-action@v2.3.11
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
commit_message: "docs: Update contributors list in README"
|
||||
118
README.md
118
README.md
|
|
@ -1,127 +1,41 @@
|
|||
# SharedCourses
|
||||
|
||||
## 华东师范大学课程共享计划
|
||||
|
||||
### 项目简介
|
||||
|
||||
> 本项目起源于 [タクヤマ](https://github.com/takuyamafuru) 的 [ECNU_Crypt_Student_Manual](https://github.com/BetterECNU/ECNU_Crypt_Student_Manual) <br>
|
||||
> 由 [Eagle233](https://github.com/Eagle233Fake) 提出整合想法, 并建立第一版仓库 [ECNU-SharedCourses](https://github.com/BetterECNU/ECNU-SharedCourses) <br>
|
||||
> 经由 [KirisameVanilla](https://github.com/KirisameVanilla) 重构, 最终呈现为本仓库。
|
||||
|
||||
本项目旨在为华东师范大学的学生提供一个统一、开放的课程资料共享平台。
|
||||
## 项目简介
|
||||
|
||||
目前我校的课程资料存在如下的特征:
|
||||
本项目旨在为华东师范大学学生提供统一、开放的课程资料共享平台，集中整理、公开共享各类课程资源，欢迎所有人参与贡献。
|
||||
|
||||
1. **历代传承**: 课程资源由学长学姐多年整理积累, 可能只在部分人手中流通.
|
||||
2. **分散存放**: 资源散落在各个 GitHub 仓库, 难以集中有效地被检索.
|
||||
3. **垄断流通**: 部分资源被少数人低价售卖, 同时难以保证其完整性和可靠性.
|
||||
## 项目目标
|
||||
|
||||
### 项目目标
|
||||
- 统一汇总分散的课程资源
|
||||
- 公开共享，任何人可访问和使用
|
||||
- 开放更新，持续完善内容
|
||||
|
||||
计划旨在解决当前课程资料存在的问题, 并实现以下目标:
|
||||
## 快速开始
|
||||
|
||||
1. **统一汇总**: 将分散的课程资源集中到一个平台.
|
||||
2. **公开共享**: 秉承开源精神, 任何人都能自由访问与使用.
|
||||
3. **开放更新**: 任何人都可以上传和更新资源, 保持内容持续完善.
|
||||
|
||||
### 面向用户
|
||||
|
||||
平台面向的同学:
|
||||
|
||||
1. **获取资料**: 想要获取资源的同学可直接[访问网站](https://courses.ecnu.vanillaaaa.org/).
|
||||
2. **共享资料**: 愿意贡献资源的同学可按规范提交 PR 或通过邮件提交文件, 审核通过后合并到平台.
|
||||
1. 访问[项目网站](https://courses.ecnu.vanillaaaa.org/)浏览和下载资料
|
||||
2. 贡献资料：Fork 本仓库，按命名规范添加资料，提交 PR，等待审核合并
|
||||
|
||||
## 贡献指南
|
||||
|
||||
### 标准化命名规则
|
||||
- 命名规范：建议采用“科目_院系_学期_考试类型_其他信息.格式”方式命名
|
||||
- 资料类型：试卷、答案、讲义等均可提交
|
||||
- Commit 说明：如 `add: 软件工程学院-计算机系统`，`update: 软件工程学院-计算机系统` 等
|
||||
|
||||
#### 真题卷命名规则
|
||||
|
||||
```bash
|
||||
[科目]_[开课院系]_[学期]_[考试类型][序号 (可选)]_[A/B卷 (可选)]_[标注 (可选)]_[备注 (可选)].[格式]
|
||||
```
|
||||
|
||||
#### 字段说明
|
||||
|
||||
1. **科目**: 填写完整科目名称, 如 "线性代数", "城市文明史", "学术英语写作"
|
||||
2. **开课院系**: 填写完整院系名称, 如 "软件工程学院", "马克思主义学院"
|
||||
3. **学期**: 填写 "2024Fall" 或 "2023Spring" 或 "2025Summer"(暑假短学期)
|
||||
4. **考试类型**: 如 "月考", "期中", "期末"
|
||||
5. **序号 (可选)**: 同类考试可添加序号, 如 "月考1", "月考2"
|
||||
6. **A/B卷 (可选)**: 如果存在 A 卷或 B 卷, 填写 "A" 或 "B", 没有可不标
|
||||
7. **标注 (可选)**:
|
||||
- "含答案": 试卷 + 答案文件
|
||||
- "答案": 只有答案文件
|
||||
- 空: 只有试卷
|
||||
8. **备注 (可选)**: 其他需要说明的信息, 应对同一门课程同一时期的不同平行班的不同卷子, 如"cr回忆版"
|
||||
|
||||
#### 命名示例
|
||||
|
||||
| 科目 | 院系 | 学期 | 考试类型 | 序号 | A/B卷 | 标注 | 格式 | 文件名示例 |
|
||||
| ------ | ------- |------------| ---- | -- | ---- | --- | ---- |----------------------------------------|
|
||||
| 线性代数 | 软件工程学院 | 2024Fall | 期中 | | | 含答案 | pdf | 线性代数\_软件工程学院\_2024Fall\_期中\_含答案.pdf |
|
||||
| 城市文明史 | 历史学系 | 2025Summer | 期末 | | | 答案 | pdf | 城市文明史\_历史学系\_2025Summer\_期末\_答案.pdf |
|
||||
| 学术英语写作 | 大学英语教学部 | 2025Spring | 期末 | | | | docx | 学术英语写作\_大学英语教学部\_2025Spring\_期末.docx |
|
||||
| 有机化学 | 生物学系 | 2024Fall | 月考 | 2 | B | 含答案 | docx | 有机化学\_生物学系\_2024Fall\_月考2\_B\_含答案.docx |
|
||||
|
||||
### Commit 规范
|
||||
|
||||
#### 类型说明
|
||||
|
||||
| 类型 | 用途说明 |
|
||||
| -------- | --------------------------- |
|
||||
| `add` | 新增资料（试卷、答案、讲义等） |
|
||||
| `update` | 修订 / 更新已有资料 |
|
||||
| `rename` | 重命名文件 / 目录 |
|
||||
| `remove` | 删除资料 |
|
||||
| `docs` | 文档说明更新（如命名规范文档、使用说明等） |
|
||||
| `build` | 修改组织架构（文件夹结构、资源位置等, 不涉及具体内容） |
|
||||
|
||||
#### 命名模板
|
||||
|
||||
```bash
|
||||
<type>: <院系>-<课程>
|
||||
```
|
||||
|
||||
#### 示例
|
||||
|
||||
```bash
|
||||
add: 软件工程学院-计算机系统
|
||||
update: 软件工程学院-计算机系统
|
||||
rename: 软件工程学院-计算机系统
|
||||
remove: 软件工程学院-计算机系统
|
||||
docs: 更新命名规范文档
|
||||
build: 调整资源目录结构
|
||||
```
|
||||
<!-- readme: contributors -start -->
|
||||
<!-- readme: contributors -end -->
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
docs/
|
||||
├── courses/ # 课程资料目录
|
||||
│ ├── 软件工程学院/
|
||||
│ ├── 数据科学与工程学院/
|
||||
│ ├── 数学科学学院/
|
||||
│ └── 大学英语教学部/
|
||||
└── guide/ # 使用指南
|
||||
└── .vuepress/ # 项目配置
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
|
||||
1. 访问[项目网站](https://courses.ecnu.vanillaaaa.org/)浏览和下载资料
|
||||
2. 要贡献资料，请：
|
||||
- Fork 本仓库
|
||||
- 按照命名规范添加资料
|
||||
- 提交 PR
|
||||
- 等待审核合并
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用开源许可证，欢迎所有人参与贡献！
|
||||
|
||||
## 联系我们
|
||||
|
||||
如有问题或建议，欢迎通过以下方式联系：
|
||||
- 提交 Issue
|
||||
- 发送邮件
|
||||
- 提交 Pull Request
|
||||
如有问题或建议，欢迎通过 Issue、邮件或 Pull Request 联系我们。
|
||||
|
|
|
|||
Loading…
Reference in New Issue