Merge branch 'master' of github.com:ClusterM/nes-containers

1 files changed, 69 insertions, 6 deletions

diff --git a/README.md b/README.md
index 087c456..aaab05e 100644
--- a/README.md
+++ b/README.md
@@ -9,17 +9,80 @@ There are three classes for different type of containers.
 
 ### .nes (iNES, NES 2.0)
 
-Most popular ROM container.
+Most popular ROM container. Most older ROMs are stored in the iNES format, but most modern dumps usually use the newer version: NES 2.0. This class supports both.
 
 Load ROM: `var nesfile = new NesFile(filename)` or `var nesfile = NesFile.FromFile(filename)`
 
-Access different fields:
+Access fields:
 
-`nesfile.Mapper = 4;` // Set mapper
+Set mapper: `nesfile.Mapper = 4;`
 
-`nesfile.PRG = new byte[32768]; // Set PRG data
+Set version to NES 2.0: `nes.Version = NesFile.iNesVersion.NES20;`
 
-`nesfile.CHR = new byte[8192];  // Set CHR data
+Set PRG data: `nesfile.PRG = new byte[32768] { ... };`
 
-`nesfile.Battery = true;        // Enable battery saves
+Set CHR data: `nesfile.CHR = new byte[8192] { ... };`
 
+Enable battery saves: `nesfile.Battery = true;`
+
+Save ROM as .nes file: `nesfile.Save(filename);`
+
+Check [documentation](https://clusterm.github.io/nes-containers/classcom_1_1clusterrr_1_1_famicom_1_1_containers_1_1_nes_file.html) for all available properties.
+
+Full format specifications: https://www.nesdev.org/wiki/INES
+
+### .unf (UNIF)
+
+UNIF (Universal NES Image Format) is an alternative format for holding NES and Famicom ROM images. Its motivation was to offer more description of the mapper board than the popular iNES format, but it suffered from other limiting constraints and a lack of popularity. The format is considered deprecated, replaced by the NES 2.0 revision of the iNES format, which better addresses the issues it had hoped to solve. There are a small number of game rips that currently only exist as UNIF. UNIF is currently considered a deprecated standard.
+
+UNIF uses key-value format fields. Key is four character string and value is binary data. In theory you can save data as any field but there are several standard fields.
+
+Load ROM: `var uniffile = new UnifFile(filename)` or `var uniffile = UnifFile.FromFile(filename)`
+
+You can assess fields like dictionary:
+
+Set mapper name: `uniffile["MAPR"] = "COOLGIRL";`
+
+Set PRG data: `uniffile["PRG0"] = new byte[...] {...};`
+
+But all standatd fields also available as properties:
+
+Set mapper name: `uniffile.Mapper = "COOLGIRL";`
+
+Set mirroring: `uniffile.Mirroring = MirroringType.MapperControlled;`
+
+Save ROM as .unf file: `unif.Save(filename);`
+
+Check [documentation](https://clusterm.github.io/nes-containers/classcom_1_1clusterrr_1_1_famicom_1_1_containers_1_1_unif_file.html) for all available properties.
+
+Full format specifications: https://www.nesdev.org/wiki/UNIF
+
+### .fds (Famicom Disk System images)
+
+The FDS format is a way to store Famicom Disk System disk data. It's much more complex format as it can contain multiple disks/sides and each disk/side contains a disk header and files.
+                                                     
+```
+                                                                         /-- File header block
+                                /-- Disk header block       /- File #1 --
+            /- Disk 1, side A ----- File amount block      /             \-- File data block
+           /                    \-- File blocks------------
+FDS file ----- Disk 1, side B                              \             /-- File header block
+           \                                                \- File #2 --
+            \- Disk 2, side A                                            \-- File data block
+```
+
+Load ROM: `var fdsfile = new FdsFile(filename)` or `var fdsfile = FdsFile.FromFile(filename)`
+
+Get disk(s) sides: `IList<FdsDiskSide> sides = fdsfile.Sides;`
+
+Get game name code: `var name = fdsfile.sides[0].GameName;`
+
+Get file name: `var filename = fdsfile.sides[0].Files[0].FileName;`
+
+Get file data: `var filedata = fdsfile.sides[0].Files[0].Data;`
+
+Save ROM as .fds file: `fdsfile.Save(filename);`
+
+Check [documentation](https://clusterm.github.io/nes-containers/classcom_1_1clusterrr_1_1_famicom_1_1_containers_1_1_fds_file.html) for all available classes and properties.
+
+Full format specifications: https://www.nesdev.org/wiki/FDS_file_format