Update serverConfig.md

trombonekenny · trombonekenny · commit 69aa7086bf95 · 2016-04-13T07:46:41.000-05:00
Updates documentation to handle newbie Windows developer hiccup.
diff --git a/doc/serverConfig.md b/doc/serverConfig.md
@@ -3,10 +3,16 @@
 
 The PrairieLearn server is configured by a JSON file called `config.json` in the current directory when the server is started (with `node server.js`). By default there is no configuration file and a default configuration will be used.
 
-To configure the server, add a file `config.json` (normally this would be in the `PrairieLearn/backend` directory). A typical example is:
+To configure the server, add a file `config.json` (normally this would be in the `PrairieLearn/backend` directory). A typical example in MacOS or Linux is:
 
     {
         "courseDir": "/Users/mwest/git/pl-tam212"
     }
 
+If you're developing in Windows, you'll need to escape the backslashes in the path with another blackslash. i.e. 
+
+    {
+        "courseDir": "D:\\GitHub\\pl-tam212"
+    }
+
 The format of `config.json` is specified by the [backend config JSON schema](https://github.com/PrairieLearn/PrairieLearn/blob/master/backend/schemas/backendConfig.json).

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,16 @@`
`3`	`3`
`4`	`4`	The PrairieLearn server is configured by a JSON file called `config.json` in the current directory when the server is started (with `node server.js`). By default there is no configuration file and a default configuration will be used.
`5`	`5`
`6`		-To configure the server, add a file `config.json` (normally this would be in the `PrairieLearn/backend` directory). A typical example is:
	`6`	+To configure the server, add a file `config.json` (normally this would be in the `PrairieLearn/backend` directory). A typical example in MacOS or Linux is:
`7`	`7`
`8`	`8`	`{`
`9`	`9`	`"courseDir": "/Users/mwest/git/pl-tam212"`
`10`	`10`	`}`
`11`	`11`
	`12`	`+If you're developing in Windows, you'll need to escape the backslashes in the path with another blackslash. i.e.`
	`13`	`+`
	`14`	`+ {`
	`15`	`+ "courseDir": "D:\\GitHub\\pl-tam212"`
	`16`	`+ }`
	`17`	`+`
`12`	`18`	The format of `config.json` is specified by the [backend config JSON schema](https://github.com/PrairieLearn/PrairieLearn/blob/master/backend/schemas/backendConfig.json).