Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README.md #5640

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve README.md #5640

wants to merge 3 commits into from
+42 −47

Conversation

AsparagusEduardo
Copy link
Collaborator

Description

  • Moved the "This is not a romhack" part to the beginning of the readme.
  • Pushed the features list to the bottom, as it may have had an effect on burying other points of the readme.
  • Added a "Should I use this or vanilla pokeemerald for my hack?" section near the top.
  • Added link to documentation page.
  • Potentially standarize the name of "Expansion Senate"? (We can discuss this if needed)
  • Other redaction improvements

Discord contact info

AsparagusEduardo

@AsparagusEduardo AsparagusEduardo added type: cleanup type: documentation Improvements or additions to documentation labels Nov 3, 2024
Pawkkie
Pawkkie reviewed Nov 4, 2024
View reviewed changes
Copy link
Collaborator

@Pawkkie Pawkkie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments, I think this looks good otherwise, all subjective of course :)

README.md
@@ -1,17 +1,54 @@
# pokeemerald-expansion

### Important: DO NOT use GitHub's "Download Zip" option. Using this option will not download the commit history required to update your expansion version or merge other feature branches. Instead, please read [this guide](https://github.com/Pawkkie/Team-Aquas-Asset-Repo/wiki/The-Basics-of-GitHub) to learn how to fork the repository and clone locally from there.
pokeemerald-expansion is ***NOT a playable romhack. It is a romhack base*** based off pret's [pokeemerald](https://github.com/pret/pokeemerald) decompilation project. It has multiple features available to romhackers so that they can create their own games, but it's not meant to be played on its own.
Copy link
Collaborator

@Pawkkie Pawkkie Nov 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the literal first thing in our README should be what pokeemerald-expansion is, not what it isn't. I'd flip the structure of this paragraph. I think having the "it's not a hack" disclaimer in paragraph 1 is good enough personally, feel free to disagree.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't disagree. I put the "not a hack" part first mainly out of spite. I can put it as the second sentence, but making it all caps, so it's still the first thing that skimmers see.

README.md Show resolved Hide resolved
@Pawkkie Pawkkie mentioned this pull request Nov 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pawkkie Pawkkie Pawkkie left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
type: cleanup type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AsparagusEduardo @Pawkkie