lole-elol / tum_cv_challenge_SS23

2 stars 2 forks source link

Add docs (cleanup) #49

Closed lufixSch closed 1 year ago

lufixSch commented 1 year ago

Improving documentation and cleaning up project structure

lufixSch commented 1 year ago

Still WIP put would be nice if you could take a look at the README.md files.

lole-elol commented 1 year ago

i think all .md files should be .txt since this was requested by the initial assignment. Apart from that it's nice

lufixSch commented 1 year ago

i think all .md files should be .txt since this was requested by the initial assignment. Apart from that it's nice

Yes thats true. I think only a readme.txt was requested but for consistency we should change all file endings

danielsanjosepro commented 1 year ago

Could we maybe just create a Readme.txt but leave the Readme.md? Otherwise there is no Markdown formatting in the main page of our repo

lufixSch commented 1 year ago

Could we maybe just create a Readme.txt but leave the Readme.md? Otherwise there is no Markdown formatting in the main page of our repo

Would be fine for me

lufixSch commented 1 year ago

Looks fine for me. Should we maybe remove my test_*.m files as well?

yes I had no time for this yesterday. And I wanted to ask before i remove them

lufixSch commented 1 year ago

I will finish the cleanup tommorow

lufixSch commented 1 year ago

I added the Readme.txt as requested by the task description. Its a combination of the README.md and gui/README.md