akanealw/misode.github.io
1
0
Fork 0
mirror of https://github.com/misode/misode.github.io.git synced 2026-04-23 07:10:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add contributing instructions to the readme

Browse Source
This commit is contained in:
Misode
2022-05-11 01:00:44 +02:00
parent 1dd724cec4
commit 77a7b94cb5
1 changed files with 27 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -1,19 +1,37 @@
# misode.github.io
Data Pack Generators for Minecraft Java Edition
Data Pack Generators and Guides for Minecraft Java Edition
https://misode.github.io/
## Translations
*Instructions stolen from [SPYGlass](https://github.com/SPYGlassMC/SPYGlass)*
## Contributing
This project uses [Preact](https://preactjs.com/) and [Vite](https://vitejs.dev/).
1. Make sure you have [node](https://nodejs.org/), npm, and [git](https://git-scm.com/) installed.
2. Clone the repository.
3. Start the dev server.
```
npm run dev
```
4. Open the browser in `localhost:3000`.
## Guides
Do you want to contribute a [guide](https://misode.github.io/guides/)?
1. Add a markdown file in `src/guides/`. It's name will be used in the url.
2. The beginning of the file contains the metadata of the guide, check the other guides for the format.
3. Start the dev server with `npm run dev`.
4. If everything is setup, saving the markdown file will update the guide in the browser.
5. To support multiple versions, wrap parts of the guide like this:
```
{#[1.18] this text will only show when 1.18 is selected #}
The selected version is {#version#}, and the pack format is {#pack_format#}
```
## Translating
misode.github.io supports multiple languages. If you'd like to help us translate this project to your language, it would be really appreciated! If your language is not on this list, please create an issue for it.
[![Localization status](https://l10n.spgoding.com/widgets/minecraft-schemas/-/multi-auto.svg)](https://l10n.spgoding.com/engage/minecraft-schemas/?utm_source=widget)
misode.github.io supports multiple languages. If you'd like to help us translate this project to your language, it would be really appreciated!
### Steps
1. Go to the [localization website](https://l10n.spgoding.com) provided by [SPGoding](https://github.com/SPGoding).
1. Go to the [localization website](https://l10n.spgoding.com) (hosted by [SPGoding](https://github.com/SPGoding)).
2. [Register](https://l10n.spgoding.com/accounts/register) by linking your GitHub account (recommended), or using your email.
- Note that the username and email will be shown in the [repository](https://github.com/misode/misode.github.io)'s git commit log.
3. See two components of misode.github.io [here](https://l10n.spgoding.com/projects/minecraft-schemas/).
3. See the components of misode.github.io [here](https://l10n.spgoding.com/projects/minecraft-schemas/).
4. Start translating!