Closed #17: Improved docu & release notes.

Orchaldir · Dec 1, 2018 · de0fcb6 · de0fcb6
1 parent 4aa34e6
commit de0fcb6
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 7 deletions.
diff --git a/FantasyWorldSimulation/docs/docu/index.adoc b/FantasyWorldSimulation/docs/docu/index.adoc
@@ -5,6 +5,8 @@ include::./release-notes.adoc[]
 
 = Maps
 
+IMPORTANT: This is a work in progress.
+
 include::maps/hierarchy.adoc[]
 
 include::maps/coordinate-systems.adoc[]
diff --git a/FantasyWorldSimulation/docs/docu/release-notes-template.adoc b/FantasyWorldSimulation/docs/docu/release-notes-template.adoc
@@ -0,0 +1,21 @@
+| XXX.X.X
+|
+
+.A Picture
+image::pitcure.png[Pitcure]
+
+*New:*
+
+* tbd
+
+*Improved:*
+
+* tbd
+
+*Fixed:*
+
+* #XXX: tbd
+
+*Known Issue:*
+
+* tbd
diff --git a/FantasyWorldSimulation/docs/docu/release-notes.adoc b/FantasyWorldSimulation/docs/docu/release-notes.adoc
@@ -25,4 +25,9 @@ image::region-map.jpg[Region Map]
 * Added loading & saving of maps.
 * Added undo & redo.
 
+*Known Issue:*
+
+* https://github.com/Orchaldir/FantasyWorldSimulation/issues/16[#16]:
+First time rendering the Region Map takes too long
+
 |===
diff --git a/README.md b/README.md
@@ -3,10 +3,6 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/93bf65e4625e4a29ad44dc47d7536139)](https://www.codacy.com/app/Orchaldir/FantasyWorldSimulation?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Orchaldir/FantasyWorldSimulation&amp;utm_campaign=Badge_Grade)
 [![Build Status](https://travis-ci.org/Orchaldir/FantasyWorldSimulation.svg?branch=master)](https://travis-ci.org/Orchaldir/FantasyWorldSimulation)
 
-## Documentation
-
-See [Documentation](FantasyWorldSimulation/docs/docu/index.adoc).
-
-## Architectural Decision Records
-
-See [Architectural Decision Records](FantasyWorldSimulation/docs/adr/index.adoc).
+* See [Architectural Decision Records](FantasyWorldSimulation/docs/adr/index.adoc).
+* See [Documentation](FantasyWorldSimulation/docs/docu/index.adoc).
+* See [Release Notes](FantasyWorldSimulation/docs/docu/release-notes.adoc).