Skip to content

Commit a0ba34c

Browse files
docs: Migrate org README to Markdown format (#766)
1 parent 730e569 commit a0ba34c

5 files changed

Lines changed: 58 additions & 27 deletions

File tree

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<div align="center">
2+
<img
3+
src="https://raw.githubusercontent.com/LizardByte/.github/refs/heads/master/branding/logos/logo.svg"
4+
alt="LizardByte icon"
5+
width="256"
6+
/>
7+
<h1 align="center">LizardByte</h1>
8+
<h4 align="center">Org level docs and standards for LizardByte.</h4>
9+
</div>
10+
11+
<div align="center">
12+
<a href="https://docs.lizardbyte.dev"><img src="https://img.shields.io/readthedocs/lizardbyte?label=Docs&style=for-the-badge&logo=readthedocs" alt="Read the Docs"></a>
13+
<a href="https://sonarcloud.io/project/overview?id=LizardByte_.github"><img src="https://img.shields.io/sonar/quality_gate/LizardByte_.github?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud" alt="SonarCloud"></a>
14+
</div>
15+
16+
# Overview
17+
18+
LizardByte has the full documentation hosted on [Read the Docs](http://lizardbyte.readthedocs.io/).
19+
20+
This documentation is being localized on [Crowdin](https://crowdin.com/project/lizardbyte-docs).
21+
22+
<p align="center">
23+
<a href="https://crowdin.com/project/lizardbyte-docs">
24+
<img
25+
src="https://raw.githubusercontent.com/LizardByte/i18n/refs/heads/crowdin-progress/LizardByte_docs_graph.svg?"
26+
alt="LizardByte documentation localization progress"
27+
/>
28+
</a>
29+
</p>
30+
31+
> [!NOTE]
32+
> **Community!**
33+
>
34+
> Accurate translations depend on contributions from amazing community members, like you! If you would like to
35+
> contribute to the localization of this documentation, please visit our
36+
> [Crowdin project](https://crowdin.com/project/lizardbyte-docs).
37+
> Thanks to all the contributors for their hard work!
38+
39+
<p align="center">
40+
<a href="https://crowdin.com/project/lizardbyte-docs">
41+
<img
42+
src="https://raw.githubusercontent.com/LizardByte/contributors/refs/heads/dist/crowdin.614257.svg?"
43+
alt="Crowdin contributors"
44+
/>
45+
</a>
46+
</p>
47+
48+
## About
49+
50+
[LizardByte](https://app.lizardbyte.dev) is developing self hosted cloud game streaming solutions.
51+
These applications are developed by volunteers in their free time. If you like our products please consider donating!

README.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/source/about/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../README.md
2+
```

docs/source/about/overview.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

profile/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
<div align="center">
2-
<img src="/branding/banners/banner.png" alt="LizardByte Banner"/>
2+
<img
3+
src="/branding/logos/logo.svg"
4+
alt="LizardByte Banner"
5+
width="256"
6+
/>
37
<h1 align="center">LizardByte</h1>
48
<h4 align="center">Discover the world of self-hosted cloud gaming!</h4>
59
</div>

0 commit comments

Comments
 (0)