mirror of
https://github.com/skyline-emu/skyline.git
synced 2024-11-30 07:04:17 +01:00
7c6ad3ccf8
The README had rendering issues on GitHub Mobile due to the "Special Thanks" ("Credits" previously) images not being correctly sized which has been resolved by removing those images. In addition, the badges at the top had unnecessary extra spacing on mobile which was required on desktop and has been fixed by exploiting differential behavior between them regarding nesting HTML line breaks (`<br>`) within a HTML hyperlink tag (`<a>`) which causes a space on desktop while not showing up on mobile.
This commit also refactors the entire file for better readability by changes such as using **bold** to emphasize points and explicit Markdown dividers (`---`) between sections.
A distinct change is clarifying that Skyline is not a Ryujinx derivative as we found a lot of people who thought this by:
* Renaming the "Credits" section to "Special Thanks"
* Explicitly specifying that Skyline is not based on it in **bold** at the end of the description
37 lines
2.6 KiB
Markdown
37 lines
2.6 KiB
Markdown
<h1 align="center">
|
|
<a href="https://github.com/skyline-emu/skyline" target="_blank">
|
|
<img height="60%" width="60%" src="https://i.imgur.com/6PJ7Ml2.png"><br>
|
|
</a>
|
|
<a href="https://discord.gg/XnbXNQM" target="_blank">
|
|
<img src="https://img.shields.io/discord/545842171459272705?label=Discord&logo=Discord&color=yellow">
|
|
</a>
|
|
<a href="https://github.com/skyline-emu/skyline/actions/workflows/ci.yml" target="_blank">
|
|
<img src="https://github.com/skyline-emu/skyline/actions/workflows/ci.yml/badge.svg"/><br>
|
|
</a>
|
|
<img src="https://forthebadge.com/images/badges/built-for-android.svg"/>
|
|
</h1>
|
|
<p align="center">
|
|
<b>Skyline</b> is an experimental emulator that runs on <b>ARMv8 Android™</b> devices and emulates the functionality of a <b>Nintendo Switch™</b> system, licensed under <a href="https://github.com/skyline-emu/skyline/blob/master/LICENSE.md"><b>Mozilla Public License 2.0</b></a>
|
|
</p>
|
|
|
|
---
|
|
|
|
### Contact
|
|
You can contact the core developers of Skyline at our **[Discord](https://discord.gg/XnbXNQM)**. If you have any questions, feel free to ask. It's also a good place to just keep up with the emulator, as most talk regarding development goes on over there.
|
|
|
|
---
|
|
|
|
### Special Thanks
|
|
A few noteworthy teams/projects who've helped us along the way are:
|
|
* **[Ryujinx](https://ryujinx.org/):** We've used Ryujinx for reference throughout the project, the amount of accuracy of their HLE kernel implementation is what makes them such an amazing reference. The team behind the project has been really helpful with any queries we've had. **It should be noted that Skyline is not based on Ryujinx**.
|
|
|
|
* **[Switchbrew](https://github.com/switchbrew/):** We've extensively used Switchbrew whether that be their **[wiki](https://switchbrew.org/)** with it's colossal amount of information on the Switch that has saved us countless hours of time or **[libnx](https://github.com/switchbrew/libnx)** which was crucial to initial development of the emulator to ensure that our HLE kernel and sysmodule implementations were accurate.
|
|
|
|
* **[Atmosphère](https://github.com/Atmosphere-NX/Atmosphere):** We've used [libmesosphere](https://github.com/Atmosphere-NX/Atmosphere/tree/master/libraries/libmesosphere) as another reference for our HLE kernel, it's faithfulness to the HOS kernel helps us a lot. This makes it invaluably important for us as a tool for writing code that can accurately emulate HOS behavior without missing any crucial parts.
|
|
|
|
---
|
|
|
|
### Disclaimer
|
|
* **Nintendo Switch** is a trademark of **Nintendo Co., Ltd**
|
|
* **Android** is a trademark of **Google LLC**
|