Ryujinx-Website/README.md

3.2 KiB


Ryujinx
Ryujinx
(REE-YOU-JINX)

Discord translation status

Changelog

The complete list of changes is available here

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:

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 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.

Donations

If you'd like to support the project financially, Ryujinx has an active Patreon campaign.

patreon

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 MIT license.