add instructions, include instructions and license in build

Author: p-svacha

FlagGeneration/FlagGeneration.csproj

@@ -115,5 +115,16 @@
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
+  <ItemGroup>
+  <!-- Copy license and instructions to output -->
+    <Content Include="..\LICENSE">
+      <Link>LICENSE</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+
+    <Content Include="instructions.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>

FlagGeneration/instructions.txt

@@ -0,0 +1,29 @@
+###### How to use the flag generator ###### 
+
+
+The generator is a simple console application. To generate flags, simply follow these steps:
+- Download the latest release from https://github.com/p-svacha/ImageGeneration/releases
+- Unpack the .zip file.
+- Open the CLI of your choice and navigate to the unpacked directory (containing `FlagGenerator.exe`)
+- Run FlagGeneration.exe with your parameters
+
+The generator requires 4 parameters (in this order):
+- directory: The path (absolute or relative) to the directory, where your new image files with the flags will be saved.
+- type: Must be "s" or "m". s generates a single flag with a specified seed, m generates multiple random flags.
+- number: Must be a number. When generating a single flag, this number represents the seed. When generating multiple flags, this number represents the amount of flags.
+- format: Must be "svg" or "png". The format of the generated image files.
+
+
+Examples (default Windows terminal):
+- To generate a single flag as a png with the seed 1312 in the current directory, run the command line with: `FlagGeneration.exe . s 1312 png`
+- To generate 10 random flags as svg's in the current directory, run the command line with: `FlagGeneration.exe . m 10 svg`
+
+
+
+###### Customizing predefined symbols ######
+ 
+Flags can contain various symbols. Often these symbols are procedurally generated, but there is also a chance that a symbol of a predefined set can appear.
+
+These predefined symbols are defined as `.svg` Files and are located in the `Resources/CoatOfArms/` directory. A set of around 200 predefined symbols is already included in the project.
+
+The set of predefined symbols that can appear in flags can be easily customized by just changing the content of the `Resources/CoatOfArms/` directory. All files in there can appear in flags with an equal chance.