mirror of https://github.com/pret/pokecrystal.git
Add an FAQ about sharing code
This commit is contained in:
parent
0ef004a4db
commit
95e48ef992
20
FAQ.md
20
FAQ.md
|
@ -16,6 +16,7 @@
|
|||
- [How do I edit maps?](#how-do-i-edit-maps)
|
||||
- [How do I edit the colors of an image?](#how-do-i-edit-the-colors-of-an-image)
|
||||
- [How do I write new features?](#how-do-i-write-new-features)
|
||||
- [How do I share code on Discord?](#how-do-i-share-code-on-discord)
|
||||
- [I need more help!](#i-need-more-help)
|
||||
|
||||
|
||||
|
@ -84,9 +85,20 @@ It really depends on what image you're trying to change the colors of, where the
|
|||
There are a number of special-purpose scripting languages, as described in [docs](https://pret.github.io/pokecrystal/). For more general features, you'll need to code directly in [assembly language][asm]. Some of the [tutorials][tutorials] for specific features may also be helpful.
|
||||
|
||||
|
||||
## How do I share code on Discord?
|
||||
|
||||
If you're looking for help on Discord, you'll probably need to share your code. How to do this:
|
||||
|
||||
- Post *short* pieces of code in Discord messages, surrounded with three <code>\`\`\`backticks\`\`\`</code> to make a [code block][markdown].
|
||||
- Post longer pieces of code by linking to [GitHub Gist][gist], [Pastebin][pastebin], [Hastebin][hastebin], or other such sites.
|
||||
- Share your entire pokecrystal project at once by hosting it on GitHub as a fork of this repository. Read the [GitHub Help][forkhelp] for details.
|
||||
|
||||
If your code is on GitHub, you can [link to specific lines][snippethelp]. Put "`#L42`" at the end of a URL to link to line 42, or "`#L10-L20`" to link to lines 10-20. For example: [https://github.com/pret/pokecrystal/blob/master/main.asm#L21-L26](https://github.com/pret/pokecrystal/blob/master/main.asm#L21-L26)
|
||||
|
||||
|
||||
## I need more help!
|
||||
|
||||
Try asking on IRC or Discord (see [README.md](README.md)).
|
||||
Try asking on Discord or IRC (see [README.md](README.md)).
|
||||
|
||||
[cygwin]: https://cygwin.com/install.html
|
||||
[rgbds]: https://github.com/rednex/rgbds/releases
|
||||
|
@ -97,3 +109,9 @@ Try asking on IRC or Discord (see [README.md](README.md)).
|
|||
[irfanview]: https://www.irfanview.com/
|
||||
[asm]: https://github.com/pret/pokecrystal/wiki/Assembly-programming
|
||||
[tutorials]: https://github.com/pret/pokecrystal/wiki/Tutorials
|
||||
[markdown]: https://support.discordapp.com/hc/en-us/articles/210298617
|
||||
[gist]: https://gist.github.com/
|
||||
[pastebin]: https://pastebin.com/
|
||||
[hastebin]: https://hastebin.com/
|
||||
[forkhelp]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
|
||||
[snippethelp]: https://help.github.com/en/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet
|
||||
|
|
Loading…
Reference in New Issue