Change in README file type and addition of installation README #93
Conversation
INSTALL.rst
Outdated
| @@ -0,0 +1,34 @@ | |||
| Installation Instructions | |||
| ================== | |||
| GalSim-Euclid-Like is a python module implemented mainly in Python. It currently supports Python versions 3.10 and above. | |||
There was a problem hiding this comment.
"is a python module implemented mainly in Python" reads a bit strange to me.
There was a problem hiding this comment.
Yes I agree, I am not sure if this is necessary information or not.
There was a problem hiding this comment.
I would simplify it to The GalSim-Euclid-Like repository contains two python libraries and currently supports Python versions 3.10 and above.
There was a problem hiding this comment.
Addressed.
|
|
||
| Attribution for software and data used by particular routines in this library is given in the docstring for the relevant routine. | ||
|
|
||
| Installation |
There was a problem hiding this comment.
I thought the idea is that we won't have an installation section in the README, but will simply point to the INSTALL.rst for instructions? If we leave it here then we have to always keep both versions up to date.
There was a problem hiding this comment.
I was trying to follow what GalSim does, which is have some basic installation instructions in the README and more in detail instructions in the INSTALL file. But it's a good point about having to keep both versions up to date.
Co-authored-by: Rachel Mandelbaum <[email protected]>
The README file type has been changed from
.mdto.rst, in part for additional complexity provided by rst and in preparation for Sphinx integration. Installation readme has also been added.