search

knbarton / ners570-finalproject

Ners 570 Final Project
1 stars 1 forks source link

Add Documentation #3

Open littlewatkins opened 3 years ago

littlewatkins commented 3 years ago

Issue

The goal is to have this project well documented. This includes code comments and a readme.md document that acts as a user manual.

knbarton commented 3 years ago

I added a couple sections to the readme for explaining how to run the code and describing the code. I think it would be a good place to include the UML diagrams too. What do you think?

littlewatkins commented 3 years ago

The readme makes sense to me as the spot to put the UML diagrams, but I'll ask Prof. Kochunas what his thoughts are on that.

littlewatkins commented 3 years ago

I talked to Prof. Kochunas and he said generally you don't give a user the UML diagrams because it can be more information than they need. Especially in a really large program, they don't need to know how the different class structures all interact. So, I'll probably leave it out of the readme, and maybe create a separate file that has them. That way we can both see it.

knbarton commented 3 years ago

Okay, that makes sense!