search

phyver / GameShell

a game to learn (or teach) how to use standard commands in a Unix shell
GNU General Public License v3.0
2.17k stars 138 forks source link

WISH: Add a few examples to the README #74

Closed HenrikBengtsson closed 2 years ago

HenrikBengtsson commented 2 years ago

Hi, thanks for developing this.

For someone "shopping around", it's hard to get an idea what this software actually does and what the "student" will experience, without installing and running it.

I'd like to suggest updating the README.md with a few, simple, static examples that show what the input and output of the game look like.

rlepigre commented 2 years ago

That is a good point! We actually considered (and I tried) creating an animated GIF that demonstrates what the start of the game looks like, but it was not as easy to do as I thought. Maybe we should give this another shot?

HenrikBengtsson commented 2 years ago

Those GIFs can be tedious to create and maintain. Plain text, static, examples have the advantage of being accessible.

phyver commented 2 years ago

We should definitely do something about that!

phyver commented 2 years ago

Just tried generating a gif for the first mission: https://github.com/phyver/GameShell/tree/tmp

What do you think?

phyver commented 2 years ago

And I added some a plaintext overview of the first mission later in the README.md file as well.

If you think that's good, I can add the same thing to the French README file!

rlepigre commented 2 years ago

I like the GIF! And the plaintext overview cannot hurt, so I'd keep both.

HenrikBengtsson commented 2 years ago

LGTM. Yes, plain-text overview will be nice, especially from an accessibility perspective.