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

No usage message or help command #181

Open
rhighs opened this issue Mar 8, 2023 · 3 comments
Open

No usage message or help command #181

rhighs opened this issue Mar 8, 2023 · 3 comments

Comments

@rhighs
Copy link
Contributor

rhighs commented Mar 8, 2023

Wanting to start contributing to this project I cloned the repo and started reading the code. Before reading any of it I wanted to see it running. Intuitively its pretty easy, just clementine <cartridge>, but no message or help command told me that.
This is just to say, we should add something like a help command or usage message on failed startup. Looks like a good first issue I can do myself.

@AlessioC31
Copy link
Collaborator

Wanting to start contributing to this project I cloned the repo and started reading the code. Before reading any of it I wanted to see it running. Intuitively its pretty easy, just clementine <cartridge>, but no message or help command told me that. This is just to say, we should add something like a help command or usage message on failed startup. Looks like a good first issue I can do myself.

Hello! Happy to see a new person wanting to contribute :D
I think it would be useful both for the project and for you to get started. We use discord to discuss emulator stuff, I don't know if you're in already: https://discord.gg/39W9Npmt

@AlessioC31
Copy link
Collaborator

Now that I take a look at it, I also noticed that we're not documenting the fact that the user has to provide the bios file in the same workdir where you execute clementine from and with a specific name, I think that this could be addressed in the context of this issue as well

@rhighs
Copy link
Contributor Author

rhighs commented Mar 8, 2023

That sounds great, I'll do that too 👍

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

No branches or pull requests

2 participants