add documentation files to sln

kreeben · Dec 26, 2020 · c26ca2b · c26ca2b
1 parent de6f842
commit c26ca2b
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,10 @@
+# &#9084; Resin
+
+[Introduction](https://github.com/kreeben/resin/blob/master/README.md)  
+[User guide](https://github.com/kreeben/resin/blob/master/USER-GUIDE.md) 
+
+## HTTP server Installation
+
+### Download
+
+Coming soon...
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 [![NuGet version (Newtonsoft.Json)](https://img.shields.io/nuget/v/Resin.Search.svg?style=flat-square)](https://www.nuget.org/packages/Resin.Search/) 
 
+[Installation instructions](https://github.com/kreeben/resin/blob/master/INSTALL.md)  
+[User guide](https://github.com/kreeben/resin/blob/master/USER-GUIDE.md) 
+
 ## HTTP search engine/embedded library
 Resin is a search library and service that can help you search through any vector space. It uses hardware accelerated vector operations from 
 [MathNet](https://github.com/mathnet/mathnet-numerics) to build indices of your data that you may then scan with ease, progammatically or 

diff --git a/USER-GUIDE.md b/USER-GUIDE.md
@@ -0,0 +1,8 @@
+# &#9084; Resin
+
+[Introduction](https://github.com/kreeben/resin/blob/master/README.md)  
+[Installation instructions](https://github.com/kreeben/resin/blob/master/INSTALL.md) 
+
+## User guide
+
+Coming soon...
diff --git a/src/Sir.sln b/src/Sir.sln
@@ -8,7 +8,9 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "resources", "resources", "{CA96B574-72B3-4954-8B51-4C961A6F6622}"
 	ProjectSection(SolutionItems) = preProject
 		AssemblyInfo.cs = AssemblyInfo.cs
+		..\INSTALL.md = ..\INSTALL.md
 		..\README.md = ..\README.md
+		..\USER-GUIDE.md = ..\USER-GUIDE.md
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sir.HttpServer", "Sir.HttpServer\Sir.HttpServer.csproj", "{C94C2F5D-AE55-4157-A74A-26D49EE73E96}"