Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README file to comply with MD033 MD040 writing standards #231

Merged
merged 2 commits into from
Dec 22, 2024
+23 −59
Merged

docs: Update README file to comply with MD033 MD040 writing standards #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57c6d3c
docs: Update README file to comply with MD033 MD040 writing standards
00make Dec 22, 2024
5eab75a
Merge branch 'Genesis-Embodied-AI:main' into main
00make Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 12 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,14 @@
<div align="center">
<img src="imgs/big_text.png" alt="Genesis" width="85%">
</div>

---

<div align="center">
<img src="imgs/teaser.png" width="100%">
</div>

<div align="left">
<a href="https://pypi.org/project/genesis-world/">
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/genesis-world">
</a>
<a href="https://pypi.org/project/genesis-world/">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/genesis-world">
</a>
<a href="https://github.com/Genesis-Embodied-AI/Genesis/issues">
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/Genesis-Embodied-AI/Genesis">
</a>
<a href="https://github.com/Genesis-Embodied-AI/Genesis/discussions">
<img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/Genesis-Embodied-AI/Genesis">
</a>
</div>

<p align="center">
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9"></a>
<a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9"></a>
</p>
![Genesis](imgs/big_text.png)

![Teaser](imgs/teaser.png)

[![PyPI - Version](https://img.shields.io/pypi/v/genesis-world)](https://pypi.org/project/genesis-world/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/genesis-world)](https://pypi.org/project/genesis-world/)
[![GitHub Issues](https://img.shields.io/github/issues/Genesis-Embodied-AI/Genesis)](https://github.com/Genesis-Embodied-AI/Genesis/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/Genesis-Embodied-AI/Genesis)](https://github.com/Genesis-Embodied-AI/Genesis/discussions)

[![README in English](https://img.shields.io/badge/English-d9d9d9)](./README.md)
[![简体中文版自述文件](https://img.shields.io/badge/简体中文-d9d9d9)](./README_CN.md)

# What is Genesis?

Expand Down Expand Up @@ -136,7 +118,7 @@ Genesis is a large scale effort that integrates state-of-the-art technologies of

If you used Genesis in your research, we would appreciate it if you could cite it. We are still working on a technical report, and before it's public, you could consider citing:

```
```bibtex
@software{Genesis,
author = {Genesis Authors},
title = {Genesis: A Universal and Generative Physics Engine for Robotics and Beyond},
Expand Down
40 changes: 11 additions & 29 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,14 @@
<div align="center">
<img src="imgs/big_text.png" alt="Genesis" width="85%">
</div>

---

<div align="center">
<img src="imgs/teaser.png" width="100%">
</div>

<div align="left">
<a href="https://pypi.org/project/genesis-world/">
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/genesis-world">
</a>
<a href="https://pypi.org/project/genesis-world/">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/genesis-world">
</a>
<a href="https://github.com/Genesis-Embodied-AI/Genesis/issues">
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/Genesis-Embodied-AI/Genesis">
</a>
<a href="https://github.com/Genesis-Embodied-AI/Genesis/discussions">
<img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/Genesis-Embodied-AI/Genesis">
</a>
</div>

<p align="center">
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9"></a>
<a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9"></a>
</p>
![Genesis](imgs/big_text.png)

![Teaser](imgs/teaser.png)

[![PyPI - Version](https://img.shields.io/pypi/v/genesis-world)](https://pypi.org/project/genesis-world/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/genesis-world)](https://pypi.org/project/genesis-world/)
[![GitHub Issues](https://img.shields.io/github/issues/Genesis-Embodied-AI/Genesis)](https://github.com/Genesis-Embodied-AI/Genesis/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/Genesis-Embodied-AI/Genesis)](https://github.com/Genesis-Embodied-AI/Genesis/discussions)

[![README in English](https://img.shields.io/badge/English-d9d9d9)](./README.md)
[![简体中文版自述文件](https://img.shields.io/badge/简体中文-d9d9d9)](./README_CN.md)

# 概述

Expand Down