From de0fcb6d7973ff615a5391104d45c0afcd580c3a Mon Sep 17 00:00:00 2001 From: Orchaldir Date: Sat, 1 Dec 2018 14:42:01 +0100 Subject: [PATCH] Closed #17: Improved docu & release notes. --- FantasyWorldSimulation/docs/docu/index.adoc | 2 ++ .../docs/docu/release-notes-template.adoc | 21 +++++++++++++++++++ .../docs/docu/release-notes.adoc | 5 +++++ README.md | 10 +++------ 4 files changed, 31 insertions(+), 7 deletions(-) create mode 100644 FantasyWorldSimulation/docs/docu/release-notes-template.adoc diff --git a/FantasyWorldSimulation/docs/docu/index.adoc b/FantasyWorldSimulation/docs/docu/index.adoc index ccbb0ba..788d675 100644 --- 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 new file mode 100644 index 0000000..916e8f7 --- /dev/null +++ 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 \ No newline at end of file diff --git a/FantasyWorldSimulation/docs/docu/release-notes.adoc b/FantasyWorldSimulation/docs/docu/release-notes.adoc index e96bc7b..09f7d20 100644 --- 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 + |=== \ No newline at end of file diff --git a/README.md b/README.md index b260645..1a98c03 100644 --- 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&utm_medium=referral&utm_content=Orchaldir/FantasyWorldSimulation&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). \ No newline at end of file +* 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). \ No newline at end of file