Add readme

Equbuxu · Mar 5, 2021 · 6eb91d1 · 6eb91d1
1 parent 941b998
commit 6eb91d1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/PatternGenerator/PatternGenerator.csproj b/PatternGenerator/PatternGenerator.csproj
@@ -6,6 +6,10 @@
     <UseWPF>true</UseWPF>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\Readme.md" Link="Readme.md" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="System.Drawing.Common" Version="5.0.1" />
   </ItemGroup>

diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,13 @@
+This program lets you quickly generate grids to use in drawings. Select the dimensions, click the button and the generated image will be put into the clipboard.
+
+.NET 5.0 runtime is required to run the program
+
+There are two modes; "Grid" mode lets you create a simple grid:
+
+![Grid mode](https://i.imgur.com/PB6bjj2.png)
+![Grid mode result](https://i.imgur.com/qIyUxvb.png)
+
+While "Windows" mode lets you generate a grid with windows in every cell (imitating a side of a building)
+
+![Windows mode](https://i.imgur.com/bpChYbu.png)
+![Windows mode result](https://i.imgur.com/lxE5puv.png)