geodynamics / cig_tools

Various tools for CIG and CIG projects
0 stars 2 forks source link

[WIP] Add README file. #5

Closed hlokavarapu closed 3 years ago

hlokavarapu commented 7 years ago

Added a simple straight forward README file. In addition to describing this project and providing credit, this can be expanded to include installation instructions in the future as well as a few example use cases. Just an idea.

tjesser-ucdavis-edu commented 7 years ago

Sorry, I didn't write a very useful comment, initially. Please see my edit.

hlokavarapu commented 7 years ago

Based on similarities for python based libraries such as numpy, scipy, and matplotlib, we could:

Looking though CIG codes, the only similarity seems to be that a detailed description is included about the project. Other than that, some projects further list and describe the directory structure, other projects include CI tags, links for more information of the library, and/or references to licensing.

Of these listed, I will work on what is currently possible and what ever is not possible, we may want to consider adding to the README in the near future.

hlokavarapu commented 3 years ago

Outdated PR