mirror of
https://github.com/Ryujinx/Ryujinx-Website.git
synced 2025-01-09 17:07:19 -03:00
98 lines
3.2 KiB
Markdown
98 lines
3.2 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<a href="https://ryujinx.org/"><img src="https://i.imgur.com/WcCj6Rt.png" alt="Ryujinx" width="150"></a>
|
|
<br>
|
|
<b>Ryujinx</b>
|
|
<br>
|
|
<sub><sup><b>(REE-YOU-JINX)</b></sup></sub>
|
|
<br>
|
|
|
|
</h1>
|
|
|
|
<p style="text-align:center">
|
|
<a href="https://discord.com/invite/VkQYXAZ">
|
|
<img src="https://img.shields.io/discord/410208534861447168?color=5865F2&label=Ryujinx&logo=discord&logoColor=white"
|
|
alt="Discord">
|
|
</a>
|
|
<a title="Crowdin" target="_blank" href="https://crowdin.com/project/ryujinx-website-ryujinxorg">
|
|
<img src="https://badges.crowdin.net/ryujinx-website-ryujinxorg/localized.svg" alt="translation status">
|
|
</a>
|
|
</p>
|
|
|
|
## Changelog
|
|
|
|
The complete list of changes is available [here](CHANGELOG.md)
|
|
|
|
## Contribute
|
|
|
|
### Translation
|
|
|
|
Currently, we need you to help us translate the website.
|
|
Future languages to be added:
|
|
- French
|
|
- German
|
|
- Dutch
|
|
- Portuguese
|
|
- Spanish
|
|
|
|
Follow this link to participate in the translation (via Crowdin): <https://crowdin.com/project/ryujinx-website-ryujinxorg>
|
|
|
|
### Development
|
|
|
|
We do encourage you talk to some devs in #development (on our Discord) before developing any PRs so we can make sure you aren't conflicting with another dev's plans, and so we can help you get accustomed to our code base and methods.
|
|
|
|
## Building
|
|
|
|
To build the website you need:
|
|
|
|
- [nodejs](https://nodejs.org/en/) v16.x
|
|
|
|
To start working on the website, you can build the main branch:
|
|
|
|
1. Clone the repo: `https://github.com/Ryujinx/Ryujinx-Website.git` or fork it and cd into.
|
|
2. Restore project's dependencies : `npm install`
|
|
3. Run website with `npm run dev`
|
|
|
|
### Compiles and hot-reloads for development
|
|
|
|
```
|
|
npm run dev
|
|
```
|
|
|
|
### Compiles and minifies for production
|
|
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
### Versioning
|
|
|
|
This repo use Semantic Versioning (SemVer) : https://semver.org/
|
|
|
|
Maintainer :
|
|
- Don't forget to update the [CHANGELOG.md](CHANGELOG.md) file after several changes.
|
|
- Update the translation file within Crowdin after each PR.
|
|
|
|
## Contact
|
|
|
|
If you have contributions, suggestions, need website support or just want to get in touch with the team, join our [Discord server](https://discord.com/invite/Ryujinx).
|
|
|
|
## Donations
|
|
|
|
If you'd like to support the project financially, Ryujinx has an active Patreon campaign.
|
|
|
|
<a href="https://www.patreon.com/ryujinx">
|
|
<img alt="patreon" src="https://images.squarespace-cdn.com/content/v1/560c1d39e4b0b4fae0c9cf2a/1567548955044-WVD994WZP76EWF15T0L3/Patreon+Button.png?format=500w" width="150">
|
|
</a>
|
|
|
|
All developers working on the project do so in their free time, but the project has several expenses:
|
|
* Hackable Nintendo Switch consoles to reverse-engineer the hardware
|
|
* Additional computer hardware for testing purposes (e.g. GPUs to diagnose graphical bugs, etc.)
|
|
* Licenses for various software development tools (e.g. Jetbrains, IDA)
|
|
* Web hosting and infrastructure maintenance (e.g. LDN servers)
|
|
|
|
All funds received through Patreon are considered a donation to support the project. Patrons receive early access to progress reports and exclusive access to developer interviews.
|
|
|
|
## License
|
|
|
|
This software is licensed under the terms of the <a href="https://github.com/Ryujinx/Ryujinx-Website/blob/master/LICENSE.txt" target="_blank">MIT license.</a></i><br />
|