From 360a08f580eb16848f9e6adf3da57b9d15d34d45 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Skutnik Date: Sun, 31 Oct 2021 17:40:38 -0700 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a6aa58c7..17ca222b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # `mcmap` - Isometric map visualizer -![](https://img.shields.io/badge/version-1.16.5-success) ![](https://img.shields.io/badge/version-1.17-success) +![](https://img.shields.io/badge/version-1.16.5-success) ![](https://img.shields.io/badge/version-1.17-success) ![](https://img.shields.io/badge/snapshot-21w43-blueviolet) *Original project by Simon Rettberg. All the credit goes to him for the idea and vision.* @@ -191,6 +191,18 @@ If compiling the GUI version, you will also need [`Qt`](https://www.qt.io/downlo You can also download and set up [Ubuntu on windows](https://ubuntu.com/tutorials/tutorial-ubuntu-on-windows#1-overview) then the steps are the same as Linux/Ubuntu. +### Snapshot support + +Snapshots are unsupported by default. One can enable support by using the `SNAPSHOT` `CMake` option. In linux/macOS: +``` +git clone https://github.com/spoutn1k/mcmap +mkdir -p mcmap/build && cd mcmap/build +cmake .. -DSNAPSHOT=1 +make -j +``` + +On Windows, this will depend on the software you are using to compile `mcmap`. + ## Troubleshooting ### Compilation fails