Skip to content

Commit

Permalink
📃 docs(README.md): Update README content
Browse files Browse the repository at this point in the history
  • Loading branch information
exusiaiwei committed May 13, 2024
1 parent 9024567 commit 71bc4df
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 22 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,14 @@

A comprehensive survival guide for students at Saarland University, created by students, for students. 📚

**English** · [简体中文](./README.zh-CN.md) · [Documents][docs] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
**English** · [简体中文](./README.zh-CN.md) · [English Website][english-website-link] · [中文网站][chinese-website-link]


[![中文网站][chinese-website-badge]][chinese-website-link] [![英文网站][english-website-badge]][english-website-link]

[chinese-website-badge]: https://img.shields.io/badge/中文网站-访问-blue?style=for-the-badge&logo=read-the-docs
[chinese-website-link]: https://academic.exusiaiwei.top/uni-saarland-survival-guide/zh/
[english-website-badge]: https://img.shields.io/badge/website-visit-blue?style=for-the-badge&logo=read-the-docs
[english-website-link]: https://academic.exusiaiwei.top/uni-saarland-survival-guide/en

[![GitHub Issues][github-issues-badge]][github-issues-link]
[![GitHub PRs][github-prs-badge]][github-prs-link]
[![MIT License][license-badge]][license-link]

</div>

Expand Down
29 changes: 13 additions & 16 deletions README_zh.CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,35 @@

🎓 一份由学生创建,为学生服务的萨尔大学全方位生存指南。📚

[English](./README.md) · **简体中文** · [Documents][docs] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
[English](./README.md) · **简体中文** · [English Website][english-website-link] · [中文网站][chinese-website-link]


[![中文网站][chinese-website-badge]][chinese-website-link] [![英文网站][english-website-badge]][english-website-link]

[chinese-website-badge]: https://img.shields.io/badge/中文网站-访问-blue?style=for-the-badge&logo=read-the-docs
[chinese-website-link]: https://academic.exusiaiwei.top/uni-saarland-survival-guide/zh/
[english-website-badge]: https://img.shields.io/badge/website-visit-blue?style=for-the-badge&logo=read-the-docs
[english-website-link]: https://academic.exusiaiwei.top/uni-saarland-survival-guide/en


</div>

## Table of Contents | 目录
## 目录

- [🌟 萨尔大学生存指南](#-萨尔大学生存指南)
- [Table of Contents | 目录](#table-of-contents--目录)
- [Background | 背景](#background--背景)
- [Install | 安装](#install--安装)
- [Usage | 使用](#usage--使用)
- [Contributing | 贡献](#contributing--贡献)
- [License | 许可证](#license--许可证)
- [目录](#目录)
- [背景](#背景)
- [安装](#安装)
- [使用](#使用)
- [贡献](#贡献)
- [许可证](#许可证)

## Background | 背景
## 背景

萨尔大学生存指南是由萨尔大学学生发起的一个开源项目。我们旨在为学生创建一份全面、可靠、最新的指南,帮助他们在萨尔布吕肯的大学生活中找到方向。通过汇集集体智慧的力量,我们相信这份指南能够让现有学生和未来学生受益。

## Install | 安装
## 安装

这个项目使用[Quarto](https://quarto.org/)来生成各种格式的指南。请参考官方文档来[安装Quarto](https://quarto.org/docs/get-started/)

## Usage | 使用
## 使用

生存指南的主要内容在`content`目录中。你可以使用Quarto将指南渲染为HTML、PDF或其他格式。

Expand All @@ -45,11 +42,11 @@ quarto render

有关使用Quarto的更多详细信息,请参阅[Quarto文档](https://quarto.org/docs/guide/)

## Contributing | 贡献
## 贡献

我们欢迎所有学生的贡献!请阅读我们的[贡献指南](CONTRIBUTING.md)以开始参与。

## License | 许可证
## 许可证

[MIT](LICENSE) © Uni-Saarland Survival Guide Team

Expand Down

0 comments on commit 71bc4df

Please sign in to comment.