Skip to content

Commit

Permalink
simplify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@HJfod
HJfod committed May 25, 2024
1 parent 9e6f19b commit 909c3ca
Showing 1 changed file with 48 additions and 94 deletions.
142 changes: 48 additions & 94 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
<h1>
<picture>
<img alt="BetterEdit Logo" width="100" align="left" src="logo.png">
</picture>
BetterEdit
<br />
</h1>
# <span style="display: flex; align-items: center; gap: .25em"><img src="logo-new.png" width="50"> BetterEdit</span>

<span>
<a href="LICENSE"><img alt="License Badge" src="https://img.shields.io/github/license/HJfod/BetterEdit?label=license&style=flat-square" /></a>
&ensp;&macr;&ensp;
Expand All @@ -15,95 +10,54 @@
<a href="https://github.com/HJfod/BetterEdit/pulls"><img alt="GitHub Pull Requests - Closed" src="https://img.shields.io/github/issues-pr-closed/HJfod/BetterEdit?style=flat-square" /></a>
&ensp;&macr;&ensp;
<a href="https://github.com/HJfod/BetterEdit/actions/workflows/build.yml"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/HJFod/BetterEdit/build.yml?style=flat-square" /></a>
<br /><br />
A mod that makes the <a href="https://store.steampowered.com/app/322170/Geometry_Dash/">Geometry Dash</a> editor &hellip; well &hellip; <i>better.</i>
</span>

<hr />

<h2>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/b8e16c74-87dc-43ef-8c39-8f279a9426b0">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/6535d683-a083-48a0-b440-ae9a8e172496">
<img alt="GitHub Octicons: Download" width="46" align="left" src="https://github.com/HJfod/BetterEdit/assets/24266948/6535d683-a083-48a0-b440-ae9a8e172496">
</picture>
Downloads
<br />
</h2>
<span>
There are multiple ways to install BetterEdit, ordered by level of simplicity:
<br /><br />
<ol>
<li>Search for and install BetterEdit (and CustomKeybinds!) via <a href="https://github.com/geode-sdk/geode">Geode</a>'s in-game mod manager.</li>
<li>Navigate to this repository's <a href="https://github.com/HJfod/BetterEdit/releases/latest">releases page</a> and manually download <code>hjfod.betteredit.geode</code> into <a href="https://github.com/geode-sdk/geode">Geode</a>'s mods folder (<i>located @ <code>&hellip;\Geometry Dash\geode\mods</code></i>). Do the same for <a href="https://github.com/geode-sdk/CustomKeybinds/releases/latest">CustomKeybinds</a>.</li>
</ol>
<strong>Please note that you must have at minimum <a href="https://github.com/geode-sdk/geode/releases/tag/v2.0.0-beta.18">Geode v2.0.0-beta.18</a> installed &mdash; you may need to manually use the installer again due to broken auto-updates on previous SDK versions.</strong>
</span>
A mod that makes the <a href="https://store.steampowered.com/app/322170/Geometry_Dash/">Geometry Dash</a> editor, well, <i>better</i>.

<h2>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/00ac7efc-08a3-4163-b88f-1eabd0307139">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/ec09d442-592b-4b8b-9fd9-58e5ec1af5cb">
<img alt="GitHub Octicons: Bug" width="46" align="left" src="https://github.com/HJfod/BetterEdit/assets/24266948/ec09d442-592b-4b8b-9fd9-58e5ec1af5cb" margin="0px">
</picture>
Bug Reports
<br />
</h2>
<span>
Depending on what you plan to submit, there are specific issue templates to use:
<br /><br />
<table>
<tr>
<th align="center">Reason</th>
<th align="center">Template</th>
</tr>
<tr>
<td align="center">Bug</td>
<td align="center"><a href=".github/ISSUE_TEMPLATE
/bug_report.md">Bug Report Template</a></td>
</tr>
<tr>
<td align="center">Crash</td>
<td align="center"><a href=".github/ISSUE_TEMPLATE
/crash_report.md">Crash Report Template</a></td>
</tr>
<tr>
<td align="center">Feature Suggestion</td>
<td align="center"><a href=".github/ISSUE_TEMPLATE
/suggestion.md">Suggestions Template</a></td>
</tr>
</table>
<strong>Please note that 'junk' issues will be ignored/closed without warning!</strong>
</span>
## :rocket: Installation

<h2>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/60f98530-2239-418d-b165-7066494949b4">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/234f4c0e-1589-4347-b50b-7fdfe2f48275">
<img alt="GitHub Octicons: Comment-Discussion" width="46" align="left" src="https://github.com/HJfod/BetterEdit/assets/24266948/234f4c0e-1589-4347-b50b-7fdfe2f48275">
</picture>
Contact
<br />
</h2>
<span>
BetterEdit has a <a href="https://discord.gg/rPvFW4jQTJ">Discord server</a>; this is where you can go if you need any further information, wish to ask questions, or anything else!
<br /><br />
<img alt="Discord Banner 2" src="https://discordapp.com/api/guilds/1087452688956006471/widget.png?style=banner2" />
</span>
You can install BetterEdit through [Geode](https://geode-sdk.org). After installing Geode, simply search for the mod on the in-game browser, and click install.

<h2>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/7885c455-ec8d-4c71-aa64-e6892b48edaa">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/HJfod/BetterEdit/assets/24266948/ee1e60e5-5347-4301-8ae5-d67766a820d9">
<img alt="GitHub Octicons: Law" width="46" align="left" src="https://github.com/HJfod/BetterEdit/assets/24266948/ee1e60e5-5347-4301-8ae5-d67766a820d9">
</picture>
Licensing
<br />
</h2>
<span>
<strong>BetterEdit is licensed under the <a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">LGPLv3</a> license.</strong>
<br /><br />
This means <strong>you cannot create closed-source versions of BetterEdit</strong>. You, however, can create separate closed-source mods that <i>depend</i> on BetterEdit.
<br /><br />
This is to ensure that nobody piggybacks off the hours of work spent by myself and other developers, without providing credit in the form of the free version! :^)
</span>
**BetterEdit needs the following mods to also be installed:**

* [NodeIDs](https://github.com/geode-sdk/NodeIDs)
* [Custom Keybinds (Windows only)](https://github.com/geode-sdk/CustomKeybinds)
* [GMD API](https://github.com/HJfod/GMD-API)
* [BetterSave](https://github.com/HJfod/BetterSave)

## :beetle: Bug reports & feature suggestions

You can use [Issues](https://github.com/HJfod/BetterEdit/issues) to report bugs and suggest new features! Click [here](https://github.com/HJfod/BetterEdit/issues/new/choose) to open up a new issue.

Please use the correct templates for your issue - badly formatted issues will be closed.

| Issue template name | What it's for |
| ------------------- | ------------- |
| Bug Report | Reporting a bug with the mod, such as some feature not working as expected, some buttons being misplaced, etc. |
| Crash Report | Reporting a crash with the mod (i.e. when the game closes unexpectedly) |
| Suggestion | Suggesting a new feature to be added to the mod / changes to an existing feature |

## :speech_balloon: Contact

BetterEdit has a [Discord server](https://discord.gg/rPvFW4jQTJ); this is where you can go if you need any further information, wish to ask questions, or anything else!

[<img alt="BetterEdit Discord Server Banner" src="https://discordapp.com/api/guilds/1087452688956006471/widget.png?style=banner2" />](https://discord.gg/rPvFW4jQTJ)

You can also contact the developer of the mod (HJfod) directly through Discord or Twitter/X.

* Discord: `@hjfod`
* Twitter: [`hjfod`](https://twitter.com/hjfod)

## :euro: Support

BetterEdit's development is supported via [donations on my Ko-fi](https://ko-fi.com/hjfod)!

There is also plans for a paid version called **BetterEdit Pro** in the future, however details on that will be coming later.

## :balance_scale: Licensing

**BetterEdit is licensed under the [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) license.**

This means **you cannot create closed-source versions of BetterEdit**. You, however, *can* create separate closed-source mods that depend on BetterEdit.

This is to ensure that nobody piggybacks off the hundreds of hours of work spent by myself and other developers, without providing proper credit in the form of the free version! :blush:

0 comments on commit 909c3ca

Please sign in to comment.