From 57c6d3c89cdd430be1b3f705ec4d4bdf579cabc1 Mon Sep 17 00:00:00 2001
From: Habermehl <37908699+00make@users.noreply.github.com>
Date: Sun, 22 Dec 2024 16:44:42 +0800
Subject: [PATCH] docs: Update README file to comply with MD033 MD040 writing
standards
---
README.md | 42 ++++++++++++------------------------------
README_CN.md | 40 +++++++++++-----------------------------
2 files changed, 23 insertions(+), 59 deletions(-)
diff --git a/README.md b/README.md
index c93440a..4feee6c 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,14 @@
-
-
-
-
----
-
-
-
-
-
-
-
-
-
-
-
+![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?
@@ -134,7 +116,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},
diff --git a/README_CN.md b/README_CN.md
index 4236ecb..e7c68a1 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -1,32 +1,14 @@
-
-
-
-
----
-
-
-
-
-
-
-
-
-
-
-
+![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)
# 概述