+
+
+
+Example
+-------
+
+Assume we loaded [Titanic data set](http://www.kaggle.com/c/titanic-gettingStarted)
+into a data frame called `titanic` (the data frame has numerous columns including string
+`Sex` and Boolean `Survived`). Now we can calculate the survival rates for males and females:
+
+*)
+#r "FSharp.ProjectTemplate.dll"
+open FSharp.ProjectTemplate
+
+Library.hello 0
+(**
+Some more info
+
+Samples & documentation
+-----------------------
+
+The library comes with comprehensible documentation. The tutorials and articles are
+automatically generated from `*.fsx` files in [the samples folder][samples]. The API
+reference is automatically generated from Markdown comments in the library implementation.
+
+ * [Stuff](stuff.html) has more stuff
+
+ * [API Reference](reference/index.html) contains automatically generated documentation for all types, modules
+ and functions in the library. This includes additional brief samples on using most of the
+ functions.
+
+Contributing and copyright
+--------------------------
+
+The project is hosted on [GitHub][gh] where you can [report issues][issues], fork
+the project and submit pull requests. If you're adding new public API, please also
+consider adding [samples][samples] that can be turned into a documentation. You might
+also want to read [library design notes](design.html) to understand how it works.
+
+The library is available under **INSERT** license, which allows modification and
+redistribution for both commercial and non-commercial purposes. For more information see the
+[License file][license] in the GitHub repository.
+
+ [samples]: https://github.com/fsharp/FSharp.ProjectScaffold/tree/master/samples
+ [gh]: https://github.com/fsharp/FSharp.ProjectScaffold
+ [issues]: https://github.com/fsharp/FSharp.ProjectScaffold/issues
+ [readme]: https://github.com/fsharp/FSharp.ProjectScaffold/blob/master/README.md
+ [license]: https://github.com/fsharp/FSharp.ProjectScaffold/blob/master/LICENSE.md
+*)
\ No newline at end of file
diff --git a/docs/content/tutorial.fsx b/docs/content/tutorial.fsx
new file mode 100644
index 0000000..a5ca244
--- /dev/null
+++ b/docs/content/tutorial.fsx
@@ -0,0 +1,19 @@
+(*** hide ***)
+// This block of code is omitted in the generated HTML documentation. Use
+// it to define helpers that you do not want to show in the documentation.
+#I "../../bin"
+
+(**
+Introducing your project
+========================
+
+Say more
+
+*)
+#r "FSharp.ProjectTemplate.dll"
+open FSharp.ProjectTemplate
+
+Library.hello 0
+(**
+Some more info
+*)
diff --git a/nuget/zmq_logo.png b/docs/files/img/zmq_logo.png
similarity index 100%
rename from nuget/zmq_logo.png
rename to docs/files/img/zmq_logo.png
diff --git a/docs/tools/generate.fsx b/docs/tools/generate.fsx
new file mode 100644
index 0000000..0554fba
--- /dev/null
+++ b/docs/tools/generate.fsx
@@ -0,0 +1,86 @@
+// --------------------------------------------------------------------------------------
+// Builds the documentation from `.fsx` and `.md` files in the 'docs/content' directory
+// (the generated documentation is stored in the 'docs/output' directory)
+// --------------------------------------------------------------------------------------
+
+// Binaries that have XML documentation (in a corresponding generated XML file)
+let referenceBinaries = [ "fszmq.dll" ]
+// Web site location for the generated documentation
+let website = "http://pblasucci.github.io/fszmq"
+
+// Specify more information about your project
+let info =
+ [ "project-name", "fszmq"
+ "project-author", "Paulmichael Blasucci"
+ "project-summary", "An Apache-licenced F# binding for the ØMQ concurrent programming library."
+ "project-github", "http://github.com/pblasucci/fszmq"
+ "project-nuget", "http://nuget.com/packages/fszmq" ]
+
+// --------------------------------------------------------------------------------------
+// For typical project, no changes are needed below
+// --------------------------------------------------------------------------------------
+
+#I "../../packages/FSharp.Formatting.2.1.6/lib/net40"
+#I "../../packages/RazorEngine.3.3.0/lib/net40/"
+#r "../../packages/Microsoft.AspNet.Razor.2.0.30506.0/lib/net40/System.Web.Razor.dll"
+#r "../../packages/FAKE/tools/FakeLib.dll"
+#r "RazorEngine.dll"
+#r "FSharp.Literate.dll"
+#r "FSharp.CodeFormat.dll"
+#r "FSharp.MetadataFormat.dll"
+open Fake
+open System.IO
+open Fake.FileHelper
+open FSharp.Literate
+open FSharp.MetadataFormat
+
+// When called from 'build.fsx', use the public project URL as
+// otherwise, use the current 'output' directory.
+#if RELEASE
+let root = website
+#else
+let root = "file://" + (__SOURCE_DIRECTORY__ @@ "../output")
+#endif
+
+// Paths with template/source/output locations
+let bin = __SOURCE_DIRECTORY__ @@ "../../bin"
+let content = __SOURCE_DIRECTORY__ @@ "../content"
+let output = __SOURCE_DIRECTORY__ @@ "../output"
+let files = __SOURCE_DIRECTORY__ @@ "../files"
+let templates = __SOURCE_DIRECTORY__ @@ "templates"
+let formatting = __SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting.2.1.6/"
+let docTemplate = formatting @@ "templates/docpage.cshtml"
+
+// Where to look for *.csproj templates (in this order)
+let layoutRoots =
+ [ templates; formatting @@ "templates"
+ formatting @@ "templates/reference" ]
+
+// Copy static files and CSS + JS from F# Formatting
+let copyFiles () =
+ CopyRecursive files output true |> Log "Copying file: "
+ ensureDirectory (output @@ "content")
+ CopyRecursive (formatting @@ "content") (output @@ "content") true
+ |> Log "Copying styles and scripts: "
+
+// Build API reference from XML comments
+let buildReference () =
+ CleanDir (output @@ "reference")
+ for lib in referenceBinaries do
+ MetadataFormat.Generate
+ ( bin @@ lib, output @@ "reference", layoutRoots,
+ parameters = ("root", root)::info )
+
+// Build documentation from `fsx` and `md` files in `docs/content`
+let buildDocumentation () =
+ let subdirs = Directory.EnumerateDirectories(content, "*", SearchOption.AllDirectories)
+ for dir in Seq.append [content] subdirs do
+ let sub = if dir.Length > content.Length then dir.Substring(content.Length + 1) else "."
+ Literate.ProcessDirectory
+ ( dir, docTemplate, output @@ sub, replacements = ("root", root)::info,
+ layoutRoots = layoutRoots )
+
+// Generate
+copyFiles()
+buildDocumentation()
+buildReference()
diff --git a/docs/tools/packages.config b/docs/tools/packages.config
new file mode 100644
index 0000000..26f77f2
--- /dev/null
+++ b/docs/tools/packages.config
@@ -0,0 +1,6 @@
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tools/templates/template.cshtml b/docs/tools/templates/template.cshtml
new file mode 100644
index 0000000..b409491
--- /dev/null
+++ b/docs/tools/templates/template.cshtml
@@ -0,0 +1,58 @@
+
+
+
+
+ @Title
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+