Kaynağa Gözat

Update docs

Daniele Bartolini 9 yıl önce
ebeveyn
işleme
ad3000fe7d
2 değiştirilmiş dosya ile 61 ekleme ve 3 silme
  1. 43 2
      docs/manual.txt
  2. 18 1
      docs/style.css

+ 43 - 2
docs/manual.txt

@@ -90,14 +90,55 @@ Units of measurement
 
 Pepper uses MKS (meters, kilograms and seconds) units and radians for angles.
 
+boot.config file reference
+==========================
+
+Generic configurations
+----------------------
+
+	``boot_script = "lua/game"``
+		Lua script to launch on boot
+
+	``boot_package = "boot"``
+		Package to load on boot
+
+Platform-specific configurations
+--------------------------------
+
+All configurations for a given *platform* are placed under a key named *platform*. E.g.:
+
+.. code::
+
+  // Linux-only configs
+  linux = {
+      renderer = {
+          window_width  = 1280
+          window_height = 720
+          vsync = true
+      }
+  }
+
+
+Renderer configurations
+~~~~~~~~~~~~~~~~~~~~~~~
+
+	``window_width = 1280``
+		Main window width.
+
+	``window_height = 720``
+		Main window height.
+
+	``vsync = true``
+		Whether to enable vsync.
+
 Command line reference
 ======================
 
 	``-h --help``
-		Display the help.
+		Display the help and quit.
 
 	``-v --version``
-		Display engine version.
+		Display engine version and quit.
 
 	``--source-dir <path>``
 		Use <path> as the source directory for resource compilation.

+ 18 - 1
docs/style.css

@@ -9,7 +9,7 @@
 	font-family: sans-serif;
 	font-size: 11pt;
 	line-height: 145%;
-	color: #141414;
+	color: #1f1f1f;
 }
 
 div.topic {
@@ -25,3 +25,20 @@ tt.literal {
 	border-color: #e7e7e7;
 	padding: 1px 7px 1px 7px;
 }
+
+a {
+	color: #4078c0;
+	text-decoration: none;
+}
+
+a:hover {
+	text-decoration: underline;
+}
+
+a:visited {
+	color: #4078c0;
+}
+
+a.toc-backref {
+	color: #333;
+}