# HG changeset patch
# User Sebastien Jodogne <s.jodogne@gmail.com>
# Date 1423834672 -3600
# Node ID 1609f71dc2596f46fc8a65be42cf6dabd9d1c139
# Parent  5a92665dee23d92e358c1ac9a5b3bb0fcb40d21b
readme

diff -r 5a92665dee23 -r 1609f71dc259 Plugins/Samples/ServeFolders/README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Plugins/Samples/ServeFolders/README	Fri Feb 13 14:37:52 2015 +0100
@@ -0,0 +1,52 @@
+Introduction
+============
+
+This sample plugin enables Orthanc to serve additional folders using
+its embedded Web server.
+
+
+Compilation for Linux
+=====================
+
+# mkdir Build
+# cd Build
+# cmake ..
+# make
+
+
+Cross-compilation for Windows using MinGW
+=========================================
+
+# mkdir Build
+# cd Build
+# cmake .. -DCMAKE_TOOLCHAIN_FILE=../../../Resources/MinGWToolchain.cmake
+# make
+
+
+Configuration
+=============
+
+First, generate the default configuration of Orthanc:
+https://code.google.com/p/orthanc/wiki/OrthancConfiguration
+
+Then, modify the "Plugins" option to point to the folder containing
+the built plugins.
+
+Finally, create a section "ServeFolders" in the configuration file to
+specify which folder you want to serve, and at which URI. For
+instance, the following excerpt would load the plugins from the
+working directory, then would branch the content of the folder
+"/home/jodogne/WWW/fosdem" as the URI "http://localhost:8042/fosdem":
+
+{
+  "Name" : "MyOrthanc",
+  [...]
+  "HttpPort" : 8042,
+  [...]
+  "Plugins" : [ 
+    "."
+  ],
+  "ServeFolders" : {
+    "/fosdem" : "/home/jodogne/WWW/fosdem"
+  }
+}