From c306c6b27375ef39193fddccad11fe1c6c4a2eb7 Mon Sep 17 00:00:00 2001
From: 1computer1 <onecomputer00@gmail.com>
Date: Mon, 22 Jun 2020 02:55:37 -0400
Subject: [PATCH] format and document config example

---
 config.example.yaml | 49 +++++++++++++++++++++++++++++++++------------
 1 file changed, 36 insertions(+), 13 deletions(-)

diff --git a/config.example.yaml b/config.example.yaml
index 6094336..8b21547 100644
--- a/config.example.yaml
+++ b/config.example.yaml
@@ -1,3 +1,39 @@
+# Whether to build images concurrently.
+# This will take up more resources when building all the images for the first time.
+buildConcurrently: true
+
+# Whether to start containers on startup of myriad.
+prepareContainers: false
+
+# Interval in minutes to kill all running languages containers.
+cleanupInterval: 30
+
+# Port to run myriad on.
+port: 8081
+
+# The default language configuration.
+defaultLanguage:
+    # The maximum memory and swap usage (separately) of a container.
+    memory: 256m
+
+    # The number of CPUs to use.
+    cpus: 0.25
+
+    # Time in seconds for an evaluation before the container kills itself.
+    timeout: 20
+
+    # The maximum number of concurrent evaluations in the container.
+    concurrent: 5
+
+    # The maximum number of retries when the evaluation fails due to a non-timeout related reason.
+    retries: 10
+
+    # The maximum number of bytes that can be outputted.
+    outputLimit: 4k
+
+# The languages to enable.
+# The fields available are the same as in 'defaultLanguage', plus the name of the language.
+# The names are as in your 'languages' folder.
 languages:
     - name: apl
     - name: bash
@@ -27,16 +63,3 @@ languages:
     - name: ruby
     - name: rust
     - name: typescript
-
-defaultLanguage:
-    memory: 256m
-    cpus: 0.25
-    timeout: 20
-    concurrent: 10
-    retries: 2
-    outputLimit: 4k
-
-buildConcurrently: true
-prepareContainers: false
-cleanupInterval: 30
-port: 8081