search

heyitsalina / ant_search_algorithm

a python software project which imitates the life of ants in form of algorithms
MIT License
8 stars 0 forks source link

updated readme to fulfill documentation guidelines #121

Closed honnigmelone closed 8 months ago

honnigmelone commented 8 months ago

Hey, I added a detailed user and I think developer documentation. I tried to explain the GUI is being used, what parameters can be set and more. I also changed the picture size (quality gets worse tho) and added a Python version badge. I changed some style-related like bolding headers. Furthermore, I added a section where it is explained how to work with a venv (Please correct if i made any mistakes).

I was not sure what else to add. I wanted to cover the user and developer documentation both in the README now (I think that is what the assignment guidelines say). Do you guys think everything is covered well enough? Or maybe its to detailed now? 👀

Jonah-gr commented 8 months ago

Great additions! I don't think it's too detailed now, but we'll have to change a few things over time anyway :) Perhaps we can add a table of contents later.