From de745e0310c38b7e87771b014b13fa329318a02d Mon Sep 17 00:00:00 2001 From: Alexander Heusingfeld Date: Fri, 26 Jun 2020 18:46:55 +0200 Subject: [PATCH] Removed reference to curriculumBaseName --- README.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index 34d62c8..d7526c1 100644 --- a/README.adoc +++ b/README.adoc @@ -43,7 +43,7 @@ Via HTTPS: git clone https://github.com/isaqb-org/advanced-template.git --recursive ---- -- -. Rename the repository to the name of your curriculum e.g. `curriculum-flex` (this is later on referred to as `curriculumBaseName`) +. Rename the repository to the name of your curriculum e.g. `curriculum-flex` . Rename the file `/docs/advanced-template.adoc` to the name of your curriculum e.g. `curriculum-flex.adoc` (this is later on referred to as `curriculumFileName`) . Open the file `./config/setup.adoc` to adjust configuration specific to your curriculum: .. `:curriculum-short: MODULKUERZEL`: this is the abbreviation of your module. Replace MODULKUERZEL with your module name e.g. FLEX @@ -51,10 +51,9 @@ git clone https://github.com/isaqb-org/advanced-template.git --recursive .. `:curriculum-name: MODULNAME IN VOLLER LAENGE`: the full English title of your CPSA-A module. replace "MODULNAME IN VOLLER LAENGE" with your module name e.g. "Flexible Architecture Models - Microservices and Self-Contained Systems" . Open the file `build.gradle` to adjust attributes specific to your curriculum: [loweralpha] -.. `curriculumBaseName`: the exact name of the github repository e.g. `curriculum-flex` or however you named your clone -.. `curriculumFileName`: the name of the github repository e.g. `curriculum-flex` (we separated these because the repo name can be different if you have multiple copies) +.. `curriculumFileName`: the name of the asciidoc root file of your curriculum e.g. `curriculum-flex` (see above! The `.adoc` suffix is added automatically, omit it here!) . Edit the file `document.version` and enter the version number this new version of the curriculum shall have e.g. "2020.1". -. Open README.adoc and replace `advanced-curriculum` with the `curriculumBaseName` +. Open README.adoc and replace the string `advanced-curriculum` with the name of your Github repository e.g. `curriculum-flex` . Build the project with http://www.gradle.com[gradle] (you need a locally installed JDK) via `./gradlew`. . Once the "BUILD SUCCESSFUL" is show, you can review the build result under `./build/index.html`