diff --git a/README.md b/README.md index fef7bda1b8b4a62719a17433628cde0403a84354..d1e81db957d32e9895da867633312131b7ca781b 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,16 @@ Usage: 1. Create a [new project](https://git-st.inf.tu-dresden.de/projects/new). Note the URL to clone the project. 2. Run `cookiecutter https://git-st.inf.tu-dresden.de/jastadd/project-templates/relast` and put in your information, especially the URL from step 1 as `project_url`. + +## Input parameters + +| Parameter Name | Default | Description | Used in/for | +|---|---|---|---| +| `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 | +| `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 | +| `version` | `"0.0.1"` | Initial version of the project | version file | diff --git a/{{cookiecutter.repo_name}}/README.md b/{{cookiecutter.repo_name}}/README.md index 7626bad4673e18a285492145d9f688c79665feba..90ac361551082dd8db49134c5e44754fa649d319 100644 --- a/{{cookiecutter.repo_name}}/README.md +++ b/{{cookiecutter.repo_name}}/README.md @@ -1,3 +1,3 @@ # {{cookiecutter.project_name}} -For documentation, please see https://{{cookiecutter.package}}.pages.st.inf.tu-dresden.de/{{cookiecutter.project_slug}} +For documentation, please see https://{{cookiecutter.package}}.pages.st.inf.tu-dresden.de/{{cookiecutter.repo_name}}