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.

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

Make list.txt and example code more intuitive #24

Merged
merged 1 commit into from
Jan 8, 2022

Conversation

vvye
Copy link
Contributor

@vvye vvye commented Dec 31, 2021

Over the past few years, many people have mistaken the effects of the example code for a bug, because they didn't know that it was there, and that the entries in list.txt existed. It's become clear that the presence of the example code is confusing, or wasn't conveyed well.

I have attempted to fix this by:

  • changing list.txt to be tidier and easier to read
  • including more eye-catching info on how to use the lists in list.txt
  • giving each list exactly one example entry, with its own code file that does nothing (the files have a comment in them explaining that they can be removed, but, crucially, nothing weird happens if they aren't removed).

@vvye
Copy link
Contributor Author

vvye commented Jan 8, 2022

I should probably mention this fixes #21.

@VitorVilela7 VitorVilela7 merged commit 4c5cb8a into VitorVilela7:master Jan 8, 2022
@VitorVilela7
Copy link
Owner

Thank you for the pull request @vvye, it's always important to make documentation clarifying as possible for the end-user experience.

@VitorVilela7 VitorVilela7 mentioned this pull request Jan 10, 2022
VitorVilela7 added a commit that referenced this pull request Jan 10, 2022
This is a solution to keep the removed files from #24 without the risk of confusing new UberASM Tool installations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants