README documentations #24
Conversation
update fork
update fork
Fork update
update fork
update branch
update branch
stephend017
left a comment
stephend017
left a comment
There was a problem hiding this comment.
The main README looks really good but i think the usage section can be improved. it gets confusing when you list all the commands then explain them. I think a better format will be to list the command and what it does together.
The scripts and retinaface README's were a bit off. I think providing the entire API is overkill. I would rather see a description, what it should be used for and a small example code snippet of it being used.
|
The usage section on the main readme needs to updated. For example, we already provide a link to the drive folder in the Installation section, there is no need to link it again in Usage. We also do not use the SSD model anymore. I would refer to Zach to find out which Retinaface model we are currently using. Also mention the fact that while we have 3 model, we are using Retinaface and we only test with retinaface. Also the commands are outdated. We use a config file now to change our system settings rather than command inputs. The script that usage section is saying to call is also outdated. I would say to communicate with Jason and get details on how the system is ran and update the usage section respectively |
3 participants
Main Readme
Readme for the scripts folder
Readme for Retinaface