mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-09-11 05:25:32 +03:00
README: Add a jump section for easy access to documentation
The link to documentation is buried near the bottom of the README, and most people don't realize that we have documentation within the repository because of this. This commit adds handy links that take you to the appropriate parts of the README, which should improve discoverability by a lot. The idea is inspired by other repositories having a similar "common links" area at the top of their READMEs.
This commit is contained in:
parent
c0a7a61288
commit
0a63e543b7
Notes:
sideshowbarker
2024-07-17 02:29:45 +09:00
Author: https://github.com/sin-ack Commit: https://github.com/SerenityOS/serenity/commit/0a63e543b7 Pull-request: https://github.com/SerenityOS/serenity/pull/18078
@ -8,6 +8,8 @@ Graphical Unix-like operating system for x86-64 computers.
|
|||||||
[![Sonar Cube Static Analysis](https://sonarcloud.io/api/project_badges/measure?project=SerenityOS_serenity&metric=ncloc)](https://sonarcloud.io/dashboard?id=SerenityOS_serenity)
|
[![Sonar Cube Static Analysis](https://sonarcloud.io/api/project_badges/measure?project=SerenityOS_serenity&metric=ncloc)](https://sonarcloud.io/dashboard?id=SerenityOS_serenity)
|
||||||
[![Discord](https://img.shields.io/discord/830522505605283862.svg?logo=discord&logoColor=white&logoWidth=20&labelColor=7289DA&label=Discord&color=17cf48)](https://discord.gg/serenityos)
|
[![Discord](https://img.shields.io/discord/830522505605283862.svg?logo=discord&logoColor=white&logoWidth=20&labelColor=7289DA&label=Discord&color=17cf48)](https://discord.gg/serenityos)
|
||||||
|
|
||||||
|
[FAQ](Documentation/FAQ.md) | [Documentation](#how-do-i-read-the-documentation) | [Build Instructions](#how-do-i-build-and-run-this)
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
SerenityOS is a love letter to '90s user interfaces with a custom Unix-like core. It flatters with sincerity by stealing beautiful ideas from various other systems.
|
SerenityOS is a love letter to '90s user interfaces with a custom Unix-like core. It flatters with sincerity by stealing beautiful ideas from various other systems.
|
||||||
@ -20,8 +22,6 @@ You can watch videos of the system being developed on YouTube:
|
|||||||
* [Linus Groh's channel](https://youtube.com/linusgroh)
|
* [Linus Groh's channel](https://youtube.com/linusgroh)
|
||||||
* [kleines Filmröllchen's channel](https://www.youtube.com/c/kleinesfilmroellchen)
|
* [kleines Filmröllchen's channel](https://www.youtube.com/c/kleinesfilmroellchen)
|
||||||
|
|
||||||
**FAQ**: [Frequently Asked Questions](https://github.com/SerenityOS/serenity/blob/master/Documentation/FAQ.md)
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
||||||
![Screenshot as of b36968c.png](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/Screenshots/screenshot-b36968c.png)
|
![Screenshot as of b36968c.png](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/Screenshots/screenshot-b36968c.png)
|
||||||
|
Loading…
Reference in New Issue
Block a user