Added the quick guide

This commit is contained in:
SwingTheVine 2025-08-10 01:52:41 -04:00
parent a3c847b30a
commit caaf9219be
2 changed files with 45 additions and 2 deletions

View file

@ -1,8 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Community Support & Questions
- name: Community Support & Questions (Discord)
url: https://discord.gg/tpeBPy46hf
about: Join the Discord if you have questions or want to discuss this mod with the community.
about: Join the Discord if you have questions or want to discuss Blue Marble with the community.
- name: Community Support & Questions (GitHub)
url: https://github.com/SwingTheVine/Wplace-BlueMarble/discussions
about: Go to the "Discussion" tab if you have questions or want to discuss Blue Marble with the community.
- name: Partnership Request
url: https://discord.com/channels/796124137042608188/1257365507812888589
about: Open a ticket in the Discord server to discuss a partnership.

View file

@ -3,6 +3,9 @@
<td><a href="#blue-marble">Blue Marble</a></td>
<td valign="top" rowspan="99"><a href="https://discord.gg/tpeBPy46hf"><img alt="Discord Banner" src="https://discord.com/api/guilds/796124137042608188/widget.png?style=banner4"></a></td>
</tr>
<tr>
<td>&emsp;<a href="#quick-guide">Quick Guide</a></td>
</tr>
<tr>
<td>&emsp;<a href="#overview">Overview</a></td>
</tr>
@ -52,6 +55,43 @@
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Build" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/build.yml/badge.svg"></a>
<a href="" target="_blank" rel="noopener noreferrer"><img alt="CodeQL" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/github-code-scanning/codeql/badge.svg"></a>
<h2>Quick Guide</h2>
<p>
Press the arrows to reveal the option you want.
<details>
<summary>
<b>I want to download Blue Marble.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="#installation-instructions">Click here</a> to view the installation instructions.
</details>
<details>
<summary>
<b>I want to ask questions about Blue Marble.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://discord.gg/tpeBPy46hf" target="_blank" rel="noopener noreferrer">Click here</a> for the Discord server invite to the Blue Marble support server.
<br>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/discussions/categories/q-a">Click here</a> for the GitHub help & question page for Blue Marble.
</details>
<details>
<summary>
<b>I want to report a bug.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues/new/choose">Click here</a> to report a bug, then choose the "Bug Report" option.
</details>
<details>
<summary>
<b>I want to suggest a feature.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues/new/choose">Click here</a> to suggest a feature, then choose the Feature Request" option.
</details>
<details>
<summary>
<b>I want to contribute.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CONTRIBUTING.md">Click here</a> to read the contributing guidelines.
</details>
</p>
<h2>Overview</h2>
<p>
Welcome to Blue Marble! Blue Marble is a userscript for the website <a href="https://wplace.live/" target="_blank" rel="noopener noreferrer">wplace.live</a>. If you like this userscript, please ⭐ the repository! If you wish to contribute to Blue Marble, check out the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">CONTRIBUTING.md</a> file in <code>docs/</code>.