move dat object layout to readme

Author: LeftofZen

OpenLocoTool/DatFileParsing/LocoObject.cs

@@ -3,50 +3,6 @@
 
 namespace OpenLocoTool.DatFileParsing
 {
-	/*
-=== Dat File Format ===
-|-File-------------------------------|
-|-S5Header-|-DatHeader--|-ObjectData-|
-
-==============================================================================================================
-
-|-S5Header----------------|
-|-Flags-|-Name-|-Checksum-|
-
-|-DatHeader-------------|
-|-Encoding-|-Datalength-|
-
-|-ObjectData-----------------------------------------|
-|-Object-|-StringTable-|-VariableData-|-GraphicsData-|
-
-==============================================================================================================
-
-|-Object-|
--- per-object
-
-|-StringTable-|
-|-String{n}---|
-
-|-VariableData-|
--- per-object
-
-|-GraphicsData------------------------------|
-|-G1Header-|-G1Element32{n}-|-ImageBytes{n}-|
-
-==============================================================================================================
-
-|-String-----------------|
-|-Language-|-StringBytes-|
-
-|-G1Header---------------|
-|-NumEntries-|-TotalSize-|
-
-|-G1Element32------------------------------------------------------|
-|-Offset-|-Width-|-Height-|-xOffset-|-yOffset-|-Flags-|-ZoomOffset-|
-
-|-ImageBytes-|
--- offset by G1Element32.Offset
-*/
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	public class LocoObject : ILocoObject
 	{

README.md

@@ -1,2 +1,47 @@
 # OpenLocoTool
 A modern implementation of 'LocoTool' for dat file parsing
+
+# Dat Object Layout
+
+|-File-------------------------------|
+|-S5Header-|-DatHeader--|-ObjectData-|
+
+======================================================================================
+
+|-S5Header----------------|
+|-Flags-|-Name-|-Checksum-|
+
+|-DatHeader-------------|
+|-Encoding-|-Datalength-|
+
+|-ObjectData-----------------------------------------|
+|-Object-|-StringTable-|-VariableData-|-GraphicsData-|
+
+======================================================================================
+
+|-Object-|
+-- <per-object>
+
+|-StringTable-|
+|-String{n}---|
+
+|-VariableData-|
+-- <per-object>
+
+|-GraphicsData------------------------------|
+|-G1Header-|-G1Element32{n}-|-ImageBytes{n}-|
+
+======================================================================================
+
+|-String-----------------|
+|-Language-|-StringBytes-|
+
+|-G1Header---------------|
+|-NumEntries-|-TotalSize-|
+
+|-G1Element32------------------------------------------------------|
+|-Offset-|-Width-|-Height-|-xOffset-|-yOffset-|-Flags-|-ZoomOffset-|
+
+|-ImageBytes-|
+-- offset by G1Element32.Offset
+