Skip to content
Snippets Groups Projects

Resolve "Add description/help text for input parameters in README"

1 file
+ 1
1
Compare changes
  • Side-by-side
  • Inline
+ 1
1
@@ -16,7 +16,7 @@ Usage:
| `repo_name` | `"test_repo"` | Name used in the URL of the project | Initialize `project_url`, `repo_url`, Generated directory |
| `project_name` | `"My New Relational RAG Project"` | (Long) name of the project | Title in README, pages |
| `project_short_name` | `"NewRelAST"` | (Short) name of the project | Name of the grammar, partly name of the test |
| `project_slug` | `"{{cookiecutter.project_name|replace(' ','_')|lower}}"` | (pre-computed) canonical name of the project without spaces | Last part of the Java package, prefix of version file, name of the published artifact |
| `project_slug` | `"{{cookiecutter.project_name\|replace(' ','_')\|lower}}"` | (pre-computed) canonical name of the project without spaces | Last part of the Java package, prefix of version file, name of the published artifact |
| `package` | `"jastadd"` | Namespace used in the URL of the project | where? |
| `project_url` | `"git@git-st.inf.tu-dresden.de:{{cookiecutter.package}}/{{cookiecutter.repo_name}}.git"` | (pre-computed) URL to clone the project using SSH | Setting git `origin` remote |
| `repo_url` | `"https://git-st.inf.tu-dresden.de/{{cookiecutter.package}}/{{cookiecutter.repo_name}}"` | (pre-computed) URL of the project | Back-link to repository in pages |
Loading