Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spoutn1k committed Nov 1, 2021
1 parent e3ac116 commit 360a08f
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.*

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 360a08f

Please sign in to comment.