Merge

FaithBeam · Nov 7, 2020 · 6fcdc3d · 6fcdc3d
2 parents 995daf8 + 7a50be4
commit 6fcdc3d
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+**This is currently considered pre-release**
+
+# Sims.Far
+A library to manipulate The Sims 1 .far files.
+
+Currently only extracts .bmps from UIGraphics.far, and has only been used on The Sims 1 Complete Collection UIGraphics.far with CRC32: 8E03701F.
+
+## Installation
+
+You can install Sims.Far as a nupkg from nuget.org.
+
+## Usage
+
+```cs
+using Sims.Far;
+
+void main()
+{
+  var far = new Far(@"C:\Program Files (x86)\Maxis\The Sims\UIGraphics\UIGraphics.far");
+  far.Extract(@"UIGraphics\");
+}
+```