From 0c095125de8840d09cc825dfc241b3e4d3617335 Mon Sep 17 00:00:00 2001
From: Valentin Popov <valentin@popov.link>
Date: Sun, 17 Sep 2023 02:45:17 +0400
Subject: Перенос старых наработок в новый репозиторий
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 libnres/README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 libnres/README.md

(limited to 'libnres/README.md')

diff --git a/libnres/README.md b/libnres/README.md
new file mode 100644
index 0000000..065bd40
--- /dev/null
+++ b/libnres/README.md
@@ -0,0 +1,25 @@
+# Library for NRes files (Deprecated)
+
+Library for viewing and retrieving game resources of the game **"Parkan: Iron Strategy"**.
+All versions of the game are supported: Demo, IS, IS: Part 1, IS: Part 2.
+Supports files with `lib`, `trf`, `rlb` extensions.
+
+The files `gamefont.rlb` and `sprites.lib` are not supported.
+This files have an unknown signature.
+
+## Example
+
+Example of extracting game resources:
+
+```rust
+fn main() {
+    let file = std::fs::File::open("./voices.lib").unwrap();
+    // Extracting the list of files
+    let list = libnres::reader::get_list(&file).unwrap();
+
+    for element in list {
+        // Extracting the contents of the file
+        let data = libnres::reader::get_file(&file, &element).unwrap();
+    }
+}
+```
-- 
cgit v1.2.3