Skip to content

README File

loripam edited this page Feb 9, 2021 · 3 revisions

readme

Create a README File

As of today, your README is the way that template users will know what to put into their ns file. (An automatically generated file in the meta directory is also planned.) So you need to be sure to tell them minimally:

  • Data Type Categories
  • Required Inputs
  • Anything else they should know to get the template to work.

Here is a sample README.