Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rly authored Oct 21, 2023
1 parent 7d818c2 commit 8cb3a8d
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,15 @@ MATLAB support is in development.
This can be useful if you want to populate an existing empty git repository with a new extension.

4. Answer the prompts, which will be used to fill in the blanks throughout the
template automatically. You will be prompted for:
- `namespace` - The name of the namespace for your extension. This could be a
template automatically. Guidelines:
- `Select a name for your extension. It must start with 'ndx-'` - The name of the namespace for your extension. This could be a
description of the extension (e.g., "ndx-cortical-surface") or the name of your
lab or group (e.g., "ndx-allen-institute"). **Namespaces MUST start with "ndx-".**
- The name should generally follow the following naming conventions:
- Use only lower-case ASCII letters (no special characters)
- Use "-" to separate different parts of the name (no spaces allowed)
- Be short and descriptive
- `description` - A description of your extension in simple terms
- `author` - Your name. This can also be a comma-separated list of names.
- `email` - Your email address. This can also be a comma-separated list of email addresses.
- `github_username` - Your username on GitHub. This can also be a comma-separated list of usernames.
- `copyright` - Copyright statement, if desired
- `version` - Version of your extension. Versioning should start at 0.1.0 and follow [semantic versioning](https://semver.org/) guidelines
- `release` - Release category, e.g. "alpha", "beta", "official"
- `license` - Name of license used for your extension source code.
A permissive license, such as BSD, should be used if possible.
lab or group (e.g., "ndx-allen-institute"). The name should generally follow the following naming conventions:
- Use only lower-case ASCII letters (no special characters)
- Use "-" to separate different parts of the name (no spaces allowed)
- Be short and descriptive
- `Select an initial version string` - Version of your extension. Versioning should start at 0.1.0 and follow [semantic versioning](https://semver.org/) guidelines
- `Select a license` - Name of license used for your extension source code. A permissive license, such as BSD, should be used if possible.
5. A new folder with the same name as your entered `namespace` will be
created. See `NEXTSTEPS.md` in that folder for the next steps in creating
your awesome new Neurodata Extension.
Expand Down

0 comments on commit 8cb3a8d

Please sign in to comment.