From d7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4 Mon Sep 17 00:00:00 2001
From: Arne Dußin
Date: Mon, 21 Dec 2020 01:22:15 +0100
Subject: Add previously missing docs where appropriate

---
 src/main.rs | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'src/main.rs')

diff --git a/src/main.rs b/src/main.rs
index 6e54c59..8c1d63e 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,3 +1,20 @@
+//! # Graf Karto cartographer
+//!
+//! ### What is it exactly
+//! Graf Karto is a table top role playing game (TTRPG) map creation tool that is optimised for real
+//! time map interaction.
+//!
+//! ### Motivation
+//! While there are certainly many TTRPG map creation tools for single user and multi user available
+//! online and on the market, we felt that most of them lack features or are to unwieldy to seriously
+//! consider for real time dungeon drawing, say for instance when drawing a map for an old school
+//! revival style game. This is why Graf Karto is optimised for speed above pretty graphical features.
+//! The aim is for the user not to have to think much about how they are going to achieve what they are
+//! doing and how they are going to make it pretty, but should just be able to *do* it, to have time to
+//! worry about other things. This does not mean that all maps created should visually be equivalent to
+//! a steaming pile of hot garbage, but if the visuals should try to get in the way, usability and speed
+//! takes precedence.
+
 #![allow(dead_code)]
 #![warn(missing_docs)]
 
@@ -25,7 +42,9 @@ use std::ffi::CString;
 use std::io;
 use transform::Transform;
 
+/// Location of the file containing the style used for the raylib user interface.
 pub const GUI_STYLE: &str = "assets/style/cyber.rgs";
+/// Location of the graf karto configuration options file.
 pub const CONFIG_FILE: &str = "config.ron";
 
 fn main() {
-- 
cgit v1.2.3-70-g09d2