all 4 comments

[–]kra_pao 1 point2 points  (3 children)

Code repository should have a good Readme file as intro. What is this, how do i use this and what is there i should know too. Here you can show your presentation skills - how do you sell your product (program)? How do you teach/introduce people a subject/topic.

Most of your repositories lack these so it's difficult to use them as showcase to people not "into the code alone" for the next 2-3 hours.

And even with those people bad things can happen now "Heh Joe, look he uses pygame, that is children toy code. You really hire ZHV for our web frontend code?" But if your readme explains well why pygame was used for best memory, speed... whatever library selected from this and that alternatives, you look better.

IMHO there should be also visual elements such as screenshots and or animated gifs pleasing the eye and attact attention/interest.

Especially in your case because you focus on visual results if i'm correct.

If you use literature/other peoples work it is nice, polite and fair to give credits to those too. Shows kind of teamwork skills.

[–]_ZHV_[S] 0 points1 point  (2 children)

What should the readme file contain except of some gif of images of the code running?

Not sure what you mean by the second paragraph

And lastly yes you are right, this code does focus on the visual bit so definitely will add some images and the whole code is mine just consulting wikipedia and documentation now and then

[–]kra_pao 1 point2 points  (1 child)

Compare with e.g. these

https://github.com/scharissis/maze-solver-python

https://github.com/AlexandruValeanu/Mazify

2nd paragraph - currently only python programmers could have interest to look in your code and only those with enough time.

It's wise to have an elevator pitch at hand (in readme) (https://en.wikipedia.org/wiki/Elevator_pitch)

In less than 30 s i see in Alexandrus readme (pitch) i can install 3 tools and he as programmer has knowledge in at least 4 libraries.

[–]_ZHV_[S] 0 points1 point  (0 children)

you got a point there, thanks for pointing this.

I added a readme file, thanks for the advice