NPScalars is lacking a README file
Thorn NPScalars from https://bitbucket.org/canuda/lean_public.git is lacking a README file.
These files must contain author, maintainer and License information such as in the template README file produced by make newthorn
Cactus Code Thorn Foo
Author(s) : John Doe
Maintainer(s): John Doe
Licence : GPL
--------------------------------------------------------------------------
1. Purpose
not documented
Comments (10)
-
reporter -
reporter @Miguel Zilhão since you are author, would you mind adding a README file, please?
-
reporter @Miguel Zilhão since you are author, would you mind adding a README file, please?
-
reporter @Miguel Zilhão since you are author, would you mind adding a README file, please?
-
i've just added a very basic one with the reference to the relevant paper in https://bitbucket.org/canuda/lean_public/commits/94d8afef93d1a13ebf855c0d51755b0692cd7e3a
is this ok? -
reporter Not quite. The format should really be the one shown in the ticket description since there README files are supposed to be machine readable (see eg https://test.cactuscode.org/documentation/Readme_Info.html). The one added does not give license, author or name of the code either.
So in this case it may be (I don’t know license or authors):
Cactus Code Thorn NPScalars Author(s) : Miguel Zilhão <miguel.zilhao.nogueira@tecnico.ulisboa.pt> Maintainer(s): Miguel Zilhão <miguel.zilhao.nogueira@tecnico.ulisboa.pt> Licence : GPL -------------------------------------------------------------------------- 1. Purpose Computes the psi4 Weyl scalar from ADMBase variables.
-
I see, sorry, I was following the Bitbucket convention. please see commit https://bitbucket.org/canuda/lean_public/commits/ef88a7ccf4ebb7b80392d0711bf4e0f6dd1ffbc2
-
reporter Very nice! Thank you!
-
reporter Addressed in git hash ef88a7c "NPScalars: update README" of lean_public
-
reporter - changed status to resolved
- Log in to comment
Still no README file. The lean_public repo does not contain a README file either so I cannot simply copy that one, the way I did in
#2245.