Add readmo

Equbuxu · Oct 16, 2019 · d66e316 · d66e316
1 parent 7843e20
commit d66e316
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/OsuCollectionPlaycount/OsuCollectionPlaycount.csproj b/OsuCollectionPlaycount/OsuCollectionPlaycount.csproj
@@ -100,6 +100,9 @@
       <Generator>ResXFileCodeGenerator</Generator>
       <LastGenOutput>Resources.Designer.cs</LastGenOutput>
     </EmbeddedResource>
+    <None Include="..\readme.md">
+      <Link>readme.md</Link>
+    </None>
     <None Include="packages.config" />
     <None Include="Properties\Settings.settings">
       <Generator>SettingsSingleFileGenerator</Generator>

diff --git a/readme.md b/readme.md
@@ -0,0 +1,13 @@
+# Osu collection playtime calculator
+This program is designed to show you how much time you have spent playing maps from each of your collections.
+It calculates playtime for each map as well as total playtime in a collection.
+
+![Screenshot](https://github.com/BYSTACK/CollectionPlaytimeCalculator/blob/master/screenshot.png "Screenshot")
+
+# Usage
+Download the latest version from 
+[releases page](https://github.com/BYSTACK/CollectionPlaytimeCalculator/releases) 
+(Windows only), unpack in and launch the executable. In case you are missing any dlls you should install
+[.NET Framework.](https://www.microsoft.com/en-us/download/details.aspx?id=49981)
+Upon launching, the program will attempt to find osu directory automatically. If it fails, you will be presented with a prompt asking you to select the directory manually.
+Please select osu your installation directory, e.g. D:\Program Files\osu!
diff --git a/screenshot.png b/screenshot.png