added a readme.txt for first installation

Author: xaviergonz

.gitignore

@@ -1,3 +1,5 @@
+/output/
+
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 

src/T4Immutable-portable/T4Immutable-portable.nuspec

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 <package >
-  <metadata minClientVersion="3.4">
+  <metadata>
     <id>T4Immutable</id>
-    <version>1.3.0-alpha3</version>
+    <version>1.3.0-alpha9</version>
     <title>T4Immutable</title>
     <authors>Javier González Garcés</authors>
     <owners>xaviergonz</owners>
@@ -14,12 +14,25 @@
     <copyright>Copyright © 2016 Javier González Garcés</copyright>
     <tags>t4 immutable codegen</tags>
     <dependencies>
-      <!--<dependency id="Microsoft.CSharp" version="4.0.0"/>-->
+      <!-- apparently not needed?
+      <dependency id="Microsoft.CSharp" version="4.0.0"/>
+      -->
     </dependencies>
+    <!-- this apparently does not work as intended for project.json files
+    <contentFiles>
+      <files include="**/*.cs_" buildAction="None"/>
+      <files include="**/*.ttinclude" buildAction="None"/>
+      <files include="**/*.t4" buildAction="Content"/>
+    </contentFiles>
+    -->
   </metadata>
   <files>
     <file src="bin\Release\T4Immutable.dll" target="lib\netstandard1.1\T4Immutable.dll" />
     <file src="bin\Release\T4Immutable.xml" target="lib\netstandard1.1\T4Immutable.xml" />
+    <file src="..\readme.txt" target=""/>
     <file src="..\content\**\*.*" target="content"/>
+    <!-- no point since this does not copy the files to the solution    
+    <file src="..\content\**\*.*" target="contentFiles\any\any"/>
+    -->
   </files>
 </package>

src/T4Immutable.sln

@@ -20,6 +20,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "T4Immutable", "T4Immutable"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "T4Immutable-portable", "T4Immutable-portable\T4Immutable-portable.csproj", "{C569B582-2D4F-45ED-964B-412E032A37C4}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{6E1256F3-7EC3-4676-9CE5-7D6379A12D86}"
+	ProjectSection(SolutionItems) = preProject
+		readme.txt = readme.txt
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

src/readme.txt

@@ -0,0 +1,32 @@
+===========
+T4Immutable
+===========
+
+Note for old-style (.NET Framework)
+-----------------------------------
+
+Please run the generator by using "Build - Transform All T4 Templates".
+You should do this after each time you update this nuget package.
+
+
+Note for new-style projects (.NET Core, .NET Standard, UWP, Portable Class Libraries...)
+----------------------------------------------------------------------------------------
+
+Since right now NuGet does not support copying files to the project itself you will need 
+to follow the next steps:
+
+1. Create a folder in the root of your project named "T4Immutable"
+2. Download the T4Immutable sources at 
+   https://github.com/xaviergonz/T4Immutable/archive/master.zip
+3. Extract the folder src/content/T4Immutable (inside the ZIP) to the T4Immutable folder 
+   of your project
+
+"Build - Transform All T4 Templates" won't work, so you will need to right click the
+file "T4Immutable/T4Immutable.tt" and click on "Run custom tool" whenever you want to 
+regenerate your templates.
+
+You will need to do 2 and 3 everytime you update this nuget package.
+
+As soon as NuGet gets better support for this (or someone tells me how to do it) for 
+new-style projects there will be an update to do this automatically like it is done for 
+standard .NET projects.