search

RIP-Comm / clementine

Gameboy Advance emulator.
MIT License
49 stars 13 forks source link

No usage message or help command #181

Open rhighs opened 1 year ago

rhighs commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

That sounds great, I'll do that too :+1: