Skip to content

How to install

Jump to bottom
guertlms edited this page Mar 6, 2020 · 1 revision

How to

How to install

Depending on your environment you can use the gradle wrapper gradlew and gradlew.bat or install gradle globally on your machine. For for convenience we will use gradle in the rest of the documentation as command name. So for example gradle build mean:

  • Windows wrapper: gradlew.bat build

  • Linux wrapper: ./gradlew build

  • Linux without wrapper: gradle build

If you want to use your own build of livingdocs in other projects on your machine, you can publish the artifacts to your local maven repository by running gradle publishToMavenLocal. After this step the livingdocs Test Framework can be used in other project by importing them with the group id org.livingdoc and the artifact id matching the project name.

How to import/open with IntelliJ

  1. File > Open

  2. Select View "Project Files"

  3. Right click build.gradle.kts > Import Gradle Project

How to run a project with LivingDoc

Running a project with LivingDoc is documented in the Demo-Project section

Known issues

If Intellij markes everything red and those markers seem to be false positive (build/test run through anyway), then this problem of resolving the imports correct can maybe addressed by: File -→ Invalide Caches/Restart …​

Clone this wiki locally