From 6752ffa91d1f5c6c1ce56cd0543ea9c7ef11b613 Mon Sep 17 00:00:00 2001
From: Gael-de-Sailly <gael.chretien@akeonet.com>
Date: Fri, 10 Apr 2020 17:29:32 +0200
Subject: [PATCH] Added README

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fad36c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+mapgen_rivers
+=============
+
+Procedural map generator for Minetest 5.x. Still experimental and basic.
+
+Contains two distinct programs: Python scripts for pre-processing, and Lua scripts to generate the map on Minetest.
+
+# Installation
+This mod should be placed in the `/mods` directory like any other Minetest mod.
+
+The Python part relies on external libraries that you need to install:
+- `numpy`, a widely used library for numerical calculations
+- `noise`, doing Perlin/Simplex noises
+- optionally, `matplotlib` (for map preview)
+
+They are commonly found on `pip` or `conda` Python distributions.
+
+# Usage
+## Pre-processing
+Run the script `terrain_rivers.py` via command line. You can optionally append the map size (by default 400). Example for a 1000x1000 map:
+```
+./terrain_rivers.py 1000
+```
+For a default 400x400 map, it should take between 1 and 2 minutes. It will generate 5 files directly in the mod folder, containing the map data (1.4 MB for the default size).
+
+## Map generation
+Just create a Minetest world with `singlenode` mapgen, enable this mod and start the world. The data files are immediately copied in the world folder so you can re-generate them afterwards, it won't affect the old worlds.