GatorCogitate / cogitate_tool

Tool to analyze contributions when working in a team.

5 stars 13 forks source link

Add updated README file #70

Closed schultzh closed 4 years ago

schultzh commented 4 years ago

The README is currently comprised of these sections. I will tag the user who is writing the sections accordingly.

Table of Contents @schultzh About @mcnultycollin Installing Testing Running @mcnultycollin Contributors @schultzh

Testing and Installing are not currently being written. If you do not currently have a task for tomorrow, please help us complete our documentation.

codecov-io commented 4 years ago

Codecov Report

Merging #70 into master will not change coverage by %. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #70   +/-   ##
=======================================
  Coverage   71.94%   71.94%           
=======================================
  Files           2        2           
  Lines         139      139           
  Branches       23       23           
=======================================
  Hits          100      100           
  Misses         36       36           
  Partials        3        3

lussierc commented 4 years ago

Hi all, I have added the "Made with Python" badge to the README as our project is based on Python. I have seen this badge used by other open source projects and by professors in the department so I figured it would be a useful addition. Let me know if you have any questions or comments!

mcnultycollin commented 4 years ago

Hi all, I made changes to the readme a few hours ago, please pull and check them out before you write anything else. Removed the section 'tests' as this didn't seem relevant and wasn't in any other readmes i could find.

mcnultycollin commented 4 years ago

I added to the installation and running section as well, it should be pretty close to complete now.

noorbuchi commented 4 years ago

@schultzh @mcnultycollin @WonjoonC I don't mean to intervene in your pull request. I just want to let you all know that the file structure has been changed significantly so updates to the structure in the README will be needed. Specifically, we've changed the number of json files, and we are working on using temporary files for test cases to avoid having 7 different json files. The file structure has not been finalized yet but I will keep you updated with what files we end up using. Please let me know if there are any questions.

schultzh commented 4 years ago

Thanks @noorbuchi !! I personally don't think that the file structure should be part of the README file. I personally don't see any value that it adds to the documentation. Any thoughts @mcnultycollin ?

mcnultycollin commented 4 years ago

Just saw the comment about removing file structure, i'll do that now.