docs: Update the Quick Guide.

Author: microbit-carlos

docs/index.md

@@ -9,7 +9,7 @@ nav_order: 1
 # micro:bit Filesystem
 {: .fs-9 }
 
-<img alt="microbit-fs logo" src="img/microbit-fs-logo.png" style="max-height: 100px; float: left; padding-right: 16px;">
+<img alt="microbit-fs logo" src="img/microbit-fs-logo.png" style="max-height: 125px; float: left; padding-right: 16px;">
 
 Manipulate files in a micro:bit MicroPython Intel Hex file.
 {: .fs-6 .fw-300 }

docs/quick-guide.md

@@ -14,6 +14,8 @@ Initialise a File System instance with a MicroPython Intel Hex string and start
 ```js
 // Create a new FileSystem instance passing the MicroPython Intel Hex string
 var micropythonFs = new microbitFs.MicropythonFsHex(IntelHexStr);
+// There are some options available in the constructor
+micropythonFs = new microbitFs.MicropythonFsHex(IntelHexStr, { maxFsSize: 20 * 1024});
 
 // Import files from a different MicroPython hex file with filesystem
 var addedFilenames = micropythonFs.importFilesFromIntelHex(UploadedHexWithUserFiles);
@@ -45,7 +47,31 @@ var intelHexStrWithFs = micropythonFs.getIntelHex();
 var intelHexBytesWithFs = micropythonFs.getIntelHexBytes();
 ```
 
-Public interface can be found in the `src/fs-interface.ts` file.
+Using multiple MicroPython Intel Hex files to generate a Universal Hex:
+
+```js
+// Create a new FileSystem instance passing the MicroPython Intel Hex string
+var micropythonFs = new microbitFs.MicropythonFsHex([
+  { hex: uPy1HexFile, boardId: 0x9900 },
+  { hex: uPy2HexFile, boardId: 0x9903 },
+]);;
+
+// Import files from a different MicroPython Intel hex file with filesystem
+var addedFilenames = micropythonFs.importFilesFromIntelHex(UploadedHexWithUserFiles);
+addedFilenames = micropythonFs.importFilesFromIntelHex(UploadedHexWithUserFiles, {overwrite: false, formatFirst: false});
+
+// Generate a new Intel hex string or Uint8Array with MicroPython and the files
+var uPy1IntelHexStrWithFs = micropythonFs.getIntelHex(0x9900);
+var uPy1IntelHexBytesWithFs = micropythonFs.getIntelHexBytes(0x9900);
+var uPy2IntelHexStrWithFs = micropythonFs.getIntelHex(0x9903);
+var uPy2IntelHexBytesWithFs = micropythonFs.getIntelHexBytes(0x9903);
+
+// Generate a new Universal hex string with all MicroPython+files data
+var universalHexStrWithFs = micropythonFs.getUniversalHex();
+```
+
+The `MicropythonFsHex` class public interface can be found in the
+`src/fs-interface.ts` file.
 
 ### Append and extract Python code from known flash location
 To add and remove the Python code using the old format:
@@ -57,16 +83,18 @@ if (microbitFs.isAppendedScriptPresent(finalHexStr)) {
 }
 ```
 
-### Read UICR data
+### Read Device Memory Info data
 
 ```js
-var uicrData = getIntelHexUicrData(IntelHexStr);
-console.log('Flash Page Size:' + uicrData.flashPageSize);
-console.log('Flash Size:' + uicrData.flashSize);
-console.log('Runtime Start Page:' + uicrData.runtimeStartPage);
-console.log('Runtime Start Address:' + uicrData.runtimeStartAddress);
-console.log('Runtime End Used:' + uicrData.runtimeEndUsed);
-console.log('Runtime End Address:' + uicrData.runtimeEndAddress);
-console.log('Version Address:' + uicrData.versionAddress);
-console.log('Version: ' + uicrData.version);
+var deviceMemInfoData = getIntelHexDeviceMemInfo(IntelHexStr);
+console.log('Flash Page Size:' + deviceMemInfoData.flashPageSize);
+console.log('Flash Size:' + deviceMemInfoData.flashSize);
+console.log('Flash Start Address:' + deviceMemInfoData.flashStartAddress);
+console.log('Flash End Address:' + deviceMemInfoData.flashEndAddress);
+console.log('Runtime Start Address:' + deviceMemInfoData.runtimeStartAddress);
+console.log('Runtime End Address:' + deviceMemInfoData.runtimeEndAddress);
+console.log('Filesystem Start Address:' + deviceMemInfoData.fsStartAddress);
+console.log('Filesystem End Address:' + deviceMemInfoData.fsEndAddress);
+console.log('MicroPython Version:' + deviceMemInfoData.uPyVersion);
+console.log('Device Version: ' + deviceMemInfoData.deviceVersion);
 ```

src/index.ts

@@ -1,3 +1,3 @@
 export * from './micropython-appended';
 export * from './micropython-fs-hex';
-export * from './uicr';
+export * from './hex-mem-info';