Skip to content

Commit

Permalink
Removed reference to curriculumBaseName
Browse files Browse the repository at this point in the history
  • Loading branch information
aheusingfeld committed Jun 26, 2020
1 parent 944dea1 commit de745e0
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,17 @@ 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
.. `:curriculum-name: MODULNAME IN VOLLER LAENGE`: the full German title of your CPSA-A module. replace "MODULNAME IN VOLLER LAENGE" with your module name e.g. "Flexible Architecture Models - Microservices und Self-Contained Systems"
.. `: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`

Expand Down

0 comments on commit de745e0

Please sign in to comment.