NPScalars is lacking a README file

Issue #2244 resolved
Roland Haas created an issue

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)

  1. Roland Haas reporter

    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.

  2. Roland Haas 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.
    

  3. Log in to comment