diff options
author | sin-ack <sin-ack@users.noreply.github.com> | 2023-03-28 20:14:02 +0000 |
---|---|---|
committer | Sam Atkins <atkinssj@gmail.com> | 2023-03-28 21:23:45 +0100 |
commit | 0a63e543b7ac1b899648b51409cc21e7ae66b194 (patch) | |
tree | c11f26f1bb9fe1c789f6287fb8104a3546c5ebd2 /README.md | |
parent | c0a7a612883b3ae27a0ab72c525bf25c6ea0103a (diff) | |
download | serenity-0a63e543b7ac1b899648b51409cc21e7ae66b194.zip |
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.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -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) [![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 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) * [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 as of b36968c.png](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/Screenshots/screenshot-b36968c.png) |