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

Add developer README page #120

Open
dabreadman opened this issue Jan 8, 2022 · 0 comments
Open

Add developer README page #120

dabreadman opened this issue Jan 8, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dabreadman
Copy link
Collaborator

dabreadman commented Jan 8, 2022 •
edited by lexesj
Loading

Why
With most of the basic features implemented, we would except less codebase refactors, which meant it would be a great time to document which go where, or at the very least, to show a straightforward way for people to add support for new pages/players.

What to do
Create a README describing

  • Compiling and loading unpack (or start:<>:<>)
  • Basic code structure
  • Basic add page/player tutorial
  • Overview on flow of events (determining malId, fetching, player manipulation, submission)
  • Key interception
@dabreadman dabreadman added the documentation Improvements or additions to documentation label Jan 8, 2022
@lexesj lexesj mentioned this issue Jan 8, 2022
Merged
9 tasks
@lexesj lexesj changed the title Add developer Readme page Add developer README page Jan 9, 2022
@dabreadman dabreadman mentioned this issue Mar 26, 2022
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dabreadman