Migrate documentation to AsciiDoc and clean repository

Author: drandarov-io

README.adoc

@@ -1,8 +1,10 @@
 = JUnit 5 Quick Start Guide and Advanced
-Dmitrij Drandarov <https://github.com>
-:images: img
+Dmitrij Drandarov <https://github.com/dmitrij-drandarov>
+:imagesdir: images
 :sectnums:
-:toc: left
+:sectanchors:
+:sectlinks:
+:toc:
 
 == Introduction
 
@@ -23,16 +25,15 @@ It pushes the D.R.Y. principle a lot!
 To understand this guide you should know the basics of testing and JUnit (4), but otherwise you wouldn't be here I guess.
 You can also check out the best-practice-part included in this repository.
 It was created by request of a colleague:
-[**Checkout JUnit best-practices included in this repository**
-](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/src/test/java/com/drandarov/bestPractice/JUnitX_XX_BestPractice.java)
+link:src/test/java/com/drandarov/bestPractice/JUnit_BestPractice.java[**Checkout JUnit best-practices included in this repository**]
 
-Also JUnit 5 supports running parallel to JUnit 4 if that's something you need.
+JUnit 5 also supports running parallel to JUnit 4 if that's something you need.
 
 Some headers related to code will have a code-link behind their name directing to the corresponding class in the GitHub-Repository.
-For the whole source code see my GitHub-Repository: [**dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced**
-](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced)
+For the whole source code see my GitHub-Repository:
+https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced[**dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced**]
 
-=== Set-Up
+=== Setup
 For an IDE I recommend *IntelliJ IDEA 2016.2(+)* right now since it brings native support for JUnit 5.
 As for dependencies:
 
@@ -42,31 +43,31 @@ As for dependencies:
   <dependency>
         <groupId>org.junit.jupiter</groupId>
         <artifactId>junit-jupiter-api</artifactId>
-        <version>5.0.0-M4</version>
+        <version>5.0.0-RC2/version>
         <scope>test</scope>
   </dependency>
 ```
 If you need lagacy support for JUnit 4 or even JUnit 3, you can add the following dependency to your project
 ```xml
   <dependency>
-        <groupId>org.junit.platform</groupId>
-        <artifactId>junit-platform-runner</artifactId>
-        <version>1.0.0-M4</version>
+        <groupId>org.junit.vintage</groupId>
+        <artifactId>junit-vintage-engine</artifactId>
+        <version>4.12.0-RC2</version>
         <scope>test</scope>
   </dependency>
 ```
 
 *Equivalents for Gradle*
 
 ```gradle
-  testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.0.0-M4'
+  testCompile 'org.junit.jupiter:junit-jupiter-api:5.0.0-RC2'
 ```
 ```gradle
-  testCompile group: 'org.junit.platform', name: 'junit-platform-runner', version: '1.0.0-M4'
+  testCompile 'org.junit.vintage:junit-vintage-engine:4.12.0-RC2'
 ```
 
 
-== General changes [(code)](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/src/test/java/com/drandarov/junit5/JUnit5_00_GeneralChanges.java)
+== General changes link:src/test/java/com/drandarov/junit5/JUnit5_00_GeneralChanges.java[(code)]
 
 
 === Syntax
@@ -149,7 +150,7 @@ void assumptionsTest() {
 ```
 
 
-== New features: Basics [(code)](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/src/test/java/com/drandarov/junit5/JUnit5_01_NewFeaturesBasics.java)
+== New features: Basics link:src/test/java/com/drandarov/junit5/JUnit5_01_NewFeaturesBasics.java[(code)]
 
 ### General
 Here I want to introduce some basics for the new features available in the new version.
@@ -166,8 +167,7 @@ There is a new pretty annotation called `@DisplayName` which is supposed to impr
 void displayNameTest() {}
 ```
 
-![img/04_displayname_result.png
-](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/img/04_displayname_result.png?raw=true)
+image::01_displayname_result.png[]
 
 You can now also group tests with inner classes annotated with `@Nested`.
 
@@ -185,8 +185,7 @@ class groupedTests {
 }
 ```
 
-![img/06_nestedTests_result.png
-](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/img/06_nestedTests_result.png?raw=true)
+image::02_nestedTests_result.png[]
 
 ### Assertions and Lambda-Support
 Now for the probably most known and anticipated feature in JUnit 5: Lambda-Support...
@@ -298,7 +297,7 @@ void parameterTest(TestInfo testInfo, TestReporter testReporter) {
 ```
 
 
-== New features: Advanced [(code)](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/src/test/java/com/drandarov/junit5/JUnit5_02_NewFeaturesAdvanced.java)
+== New features: Advanced link:src/test/java/com/drandarov/junit5/JUnit5_02_NewFeaturesAdvanced.java[(code)]
 
 ### Test-Parameters
 Building upon the `ParameterResolver` paragraph of the last chapter let's look at implementing your own `ParameterResolver`.
@@ -388,7 +387,7 @@ public class ParameterIndex_ParameterResolver implements ParameterResolver {
 ### Test-Factories
 Another nice feature are the new Test-Factories.
 These are annotated with `@TestFactory` instead of `@Test`.
-Their return type is some kind of collection of `DynamicTest`s.
+Their return type is some kind of collection of ``DynamicTest``s.
 The class `DynamicTest` provides several static methods to create those.
 You basically have to provide test data and based on it a display name as well as some kind of `Executable`.
 In my example you can see me using the `stream()`-method of said class.
@@ -414,7 +413,7 @@ Stream<DynamicTest> testStreamFactoryTest() {
 }
 ```
 
-![img/16_testFactory_result.png](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/img/16_testFactory_result.png?raw=true)
+image::03_testFactory_result.png[]
 
 ### Test-Extensions
 Here I will show you an `Extension` that is not based on the `ParameterResolver` but instead implements the `TestExecutionCondition`.
@@ -466,7 +465,7 @@ void disabledOnMondayTest() {}
 Again: This could without problem be placed on class-level.
 
 
-== Advanced Test-Samples [(code)](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/src/test/java/com/drandarov/junit5/JUnit5_00_GeneralChanges.java)
+== Advanced Test-Samples link:src/test/java/com/drandarov/junit5/JUnit5_00_GeneralChanges.java[(code)]
 
 ### Extended disabled weekdays
 Let's extend that `@DisabledOnMonday` annotation a bit.
@@ -634,7 +633,7 @@ void benchmarkedTest() {
 
 The corresponding test-output:
 
-![img/25_benchmarked_output.png](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/img/25_benchmarked_output.png?raw=true)
+image::04_benchmarked_output.png[]
 
 The extension couldn't be simpler:
 
@@ -698,12 +697,9 @@ public class BenchmarkExtension implements BeforeAllCallback, BeforeTestExecutio
 
 Of course I could have also included `@Benchmarked` in a separate `@BenchmarkedTest` annotation that would have extended `@Test` as well saving that one line.
 
-== Milestone 4 Changes [(code)](https://github.com/dmitrij-drandarov/JUnit5-Quick-Start-Guide-and-Advanced/blob/master/src/test/java/com/drandarov/junit5/JUnit5_04_Milestone_4.java)
+== Changes from M4-RC2 link:src/test/java/com/drandarov/junit5/xxxxxxxxxxx.java[(code)]
 
-### Parameterized tests
-.
-
-### Enhanced dynamic tests
+### TODO
 .
 
 == Closing words
@@ -722,3 +718,25 @@ May it be for workshops or presentations. Just give credits. ;)
 [Official JUnit 5 User Guide](http://junit.org/junit5/docs/current/user-guide)
 [JUnit 5 GitHub](https://github.com/junit-team/junit5)
 [JUnit 5 Milestone plan](https://github.com/junit-team/junit5/milestones/)
+
+== Repository Timeline
+
+[%interactive]
+- [ ] Update for M4-RC2                                 -   XX Aug 2017
+- [x] Fix userInterfaceTest                             -   01 Aug 2017
+- [x] Create wiki article with githup-pages-content     -   04 Mar 2017
+- [x] Convert code fragments from images to text        -   04 Mar 2017
+- [x] Incorporate JUnit Best-Practice on request        -   15 Feb 2017
+- [x] Change name                                       -   05 Aug 2016
+- [x] Finish Stream TODOs                               -   05 Aug 2016
+- [x] Proper Presentation                               -   04 Aug 2016
+- [x] Add reference                                     -   03 Aug 2016
+- [x] Add expectThrows()                                -   03 Aug 2016
+- [x] Add @Nested                                       -   03 Aug 2016
+- [x] Adjust packages and classes for presentation      -   01 Aug 2016
+- [x] Extend Test-Extensions                            -   29 Jul 2016
+- [x] Test-Extensions (o\j\j\api\extension)             -   28 Jul 2016
+- [x] @TestFactory + DynamicTests                       -   26 Jul 2016
+- [x] Reorder packages and classes                      -   26 Jul 2016
+- [x] Links to Java-Files                               -   24 Jul 2016
+- [x] Dependency Copy-Paste Resource                    -   24 Jul 2016