From d3e1a6cdf4c4a520eca50b799def8275bf371a6b Mon Sep 17 00:00:00 2001 From: Azgaar Date: Fri, 27 Aug 2021 23:35:32 +0300 Subject: [PATCH] readme update --- README.md | 16 +++++++++------- Readme.txt | 6 +++++- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3161d67c..8bf86ca6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Fantasy Map Generator -Azgaar's _Fantasy Map Generator_ is a free client-side web application generating interactive and highly customizable svg maps based on voronoi diagram. +Azgaar's _Fantasy Map Generator_ is a free web application generating interactive and highly customizable svg maps based on voronoi diagram. Project is under development, the current version is available on [Github Pages](https://azgaar.github.io/Fantasy-Map-Generator). -Refer to the [project wiki](https://github.com/Azgaar/Fantasy-Map-Generator/wiki) for a guidance. Some details are covered in my old blog [_Fantasy Maps for fun and glory_](https://azgaar.wordpress.com), you may also keep an eye on my [Trello devboard](https://trello.com/b/7x832DG4/fantasy-map-generator). +Refer to the [project wiki](https://github.com/Azgaar/Fantasy-Map-Generator/wiki) for guidance. The current progress is tracked in [Trello](https://trello.com/b/7x832DG4/fantasy-map-generator). Some details are covered in my old blog [_Fantasy Maps for fun and glory_](https://azgaar.wordpress.com). [![preview](https://cdn.discordapp.com/attachments/587406457725779968/594840629213659136/preview1.png)](https://i.redd.it/8bf81ir2cy631.png) @@ -12,18 +12,20 @@ Refer to the [project wiki](https://github.com/Azgaar/Fantasy-Map-Generator/wiki [![preview](https://cdn.discordapp.com/attachments/587406457725779968/594840632296734720/preview3.png)](https://cdn.discordapp.com/attachments/515359096925454350/593891237984206848/The_Wichin_Island_-_diplomacy.png) -Join our [Reddit community](https://www.reddit.com/r/FantasyMapGenerator) and [Discord server](https://discordapp.com/invite/X7E84HU) to share the created maps, discuss the Generator, suggest ideas and get a most recent updates. You may also contact me directly via [email](mailto:azgaar.fmg@yandex.by). For bug reports please use the project [issues page](https://github.com/Azgaar/Fantasy-Map-Generator/issues) or Discord "Bugs" channel. If you are facing performance issues, please read [the tips](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Tips#performance-tips). +Join our [Discord server](https://discordapp.com/invite/X7E84HU) and [Reddit community](https://www.reddit.com/r/FantasyMapGenerator) to share your creations, discuss the Generator, suggest ideas and get the most recent updates. + +Contact me via [email](mailto:azgaar.fmg@yandex.by) if you have non-public suggestions. For bug reports please use [GitHub issues](https://github.com/Azgaar/Fantasy-Map-Generator/issues) or _#bugs_ channel on Discord. If you are facing performance issues, please read [the tips](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Tips#performance-tips). Electron desktop application is available in [releases](https://github.com/Azgaar/Fantasy-Map-Generator/releases). Download archive for your architecture, unzip and run. -Pull requests are welcomed. The Tool codebase is messy and requires re-design, but I will appreciate if you start with minor changes. +Pull requests are highly welcomed. The codebase is messy and requires re-design, but I will appreciate if you start with minor changes. Check out the [data model](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Data-model) before contributing. You can support the project on [Patreon](https://www.patreon.com/azgaar). _Inspiration:_ -* Martin O'Leary's [_Generating fantasy maps_](https://mewo2.com/notes/terrain) +- Martin O'Leary's [_Generating fantasy maps_](https://mewo2.com/notes/terrain) -* Amit Patel's [_Polygonal Map Generation for Games_](http://www-cs-students.stanford.edu/~amitp/game-programming/polygon-map-generation) +- Amit Patel's [_Polygonal Map Generation for Games_](http://www-cs-students.stanford.edu/~amitp/game-programming/polygon-map-generation) -* Scott Turner's [_Here Dragons Abound_](https://heredragonsabound.blogspot.com) +- Scott Turner's [_Here Dragons Abound_](https://heredragonsabound.blogspot.com) diff --git a/Readme.txt b/Readme.txt index 6760d7eb..9d270a7c 100644 --- a/Readme.txt +++ b/Readme.txt @@ -1,5 +1,9 @@ Azgaar's Fantasy Map Generator -This is an open-source software available under MIT license + +Developed by Azgaar (azgaar.fmg@yandex.com) and contributors + +Minsk, 2017-2021. MIT License + https://github.com/Azgaar/Fantasy-Map-Generator To run the tool unzip ALL files and open index.html in browser \ No newline at end of file