Ryujinx-Website/README.md
Karim 70d6df62bd
Website redesign (#14)
* Initial project push

* Add tailwind config

* Add vue router config

* Continue

* Add generic navigation header

* Update navigations logic to prevent invalid active class

* Update HomePage.vue

* Add footer

* Add team member GitHub link

* Add new social list component

* Add SEO + favicon tag

* Update SEO tag

* Split header in multiple component

* Update i18n

* Add new homepage section

* Add new stats homepage section

* Add new section homepage section

* Add new section homepage section

* Add download page

* Update mac os section

* Add build information

* Continue

* Continue

* Continue

* Continue

* Add LDN build section

* Re order section

* Remove branch info

* Update contribute page

* Add generic button component

* Finish contribute page

* Update action logic

* Continue

* Continue

* Continue

* Fix invalid build

* Add missing token

* Fix deploy

* Update package

* Update package

* Add node version

* Fix typo

* Continue

* Fix typos

* Update teams

* Add new older build link

* Add new github action

* Add docker build

* Add LICENSE.txt and update README.md

* Add funding link

* Cleanup

* Fix invalid url

* Update .env

* Remove merge branch on release.yml

* Add asset condition

* Add sitemap.xml

* Add translation section
2022-09-07 09:32:39 +02:00

91 lines
3.0 KiB
Markdown

<h1 style="text-align:center">
<br>
<a href="https://ryujinx.org/"><img src="https://i.imgur.com/WcCj6Rt.png" alt="Ryujinx" width="150"></a>
<br>
<b>Ryujinx website</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">
<img src="https://badges.crowdin.net/ryujinx-website/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://crwd.in/ryujinx-website
### 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 Daemon, 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
```
## 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 the developers working on the project do so on 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, LDN servers, IDA)
* Web hosting and infrastructure maintenance
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 />