From aaa87e83bc06ba5e93fc962bbcda89264cf0ffa9 Mon Sep 17 00:00:00 2001 From: CobaltXII Date: Tue, 1 Jan 2019 20:54:59 -0500 Subject: [PATCH] Added usage information to README.md --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 06cc35e..e9a78a5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,24 @@ -# minceraft +# Minceraft A Minecraft clone written in C++11. -![Alt text](https://github.com/CobaltXII/minceraft/blob/master/img/screenshot_1.png?raw=true) \ No newline at end of file +![Alt text](https://github.com/CobaltXII/minceraft/blob/master/img/screenshot_1.png?raw=true) + +# Usage + +``` +Usage: ./minceraft ... + + -s [x_res y_res z_res] + + Play singleplayer. If a world save exists at , the. + world is loaded and the given dimensions (if any) are ignored. If not, + a new world is generated with the given dimensions and saved to + . + + -q [x_res y_res z_res] + + Play quickplay. A new world is generated with the given dimensions (if. + any) and is stored in memory for the duration of the gameplay. +``` +