search

Stefan-Endres / DWPM-Mixture-Model

Phase seperation calculation using the DWPM mixture rule.
7 stars 3 forks source link

Create a README file #12

Closed alchemyst closed 8 years ago

alchemyst commented 8 years ago

Please create a README file which explains what the main entry points to the code base are. I notice there are files called pure.py binary.py and nComp.py, which I assume handle progressively harder problems, but it is not clear how it all fits together. A couple of lines in a README would help anyone to navigate the code a bit better.

Stefan-Endres commented 8 years ago

I hope the new crude README will at least alleviate some confusion. I'm leaving this issue open as a reminder to write a better one once the final structure of the project comes together.

alchemyst commented 8 years ago

I'm closing this as 573c020c08db5f6cf53088b4e3c01891ca255d79 documents the project as it is now. As long as we keep it current, this is what I was looking for.