From edb52cc32cd1db0de64d2ad3f4cfc2c7b5a0f0b9 Mon Sep 17 00:00:00 2001
From: "Alan C. Assis" <acassis@gmail.com>
Date: Fri, 3 Sep 2021 10:53:45 -0300
Subject: [PATCH] Doc: Add initial documentation to the simulator

---
 Documentation/platforms/sim/index.rst     | 11 +++++
 Documentation/platforms/sim/sim/index.rst | 56 +++++++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 Documentation/platforms/sim/index.rst
 create mode 100644 Documentation/platforms/sim/sim/index.rst

diff --git a/Documentation/platforms/sim/index.rst b/Documentation/platforms/sim/index.rst
new file mode 100644
index 0000000000..2eba6c02dc
--- /dev/null
+++ b/Documentation/platforms/sim/index.rst
@@ -0,0 +1,11 @@
+==========
+Simulators
+==========
+
+The following Simulator/Emulators are supported:
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   */*
diff --git a/Documentation/platforms/sim/sim/index.rst b/Documentation/platforms/sim/sim/index.rst
new file mode 100644
index 0000000000..660859a932
--- /dev/null
+++ b/Documentation/platforms/sim/sim/index.rst
@@ -0,0 +1,56 @@
+===
+SIM
+===
+
+It is possible to run NuttX in a simulator called ``sim``, but some features
+currently are supported only on Linux host (i.e.: Bluetooth, I2C, SPI, etc).
+
+Using ``sim`` you can test many of NuttX features without a supported board.
+Examples of supported features: Audio, Bluetooth, ELF, I2C, SPI, LVGL, Flash
+File System, NX Serves, NX Demos, NX Window Manager, ROMFS, Network: TCP,
+UDP, IP,6LoWPAN, and many more.
+
+Toolchain
+=========
+
+All you need is your machine ``gcc`` working.
+
+Compiling
+=========
+
+All you need to do is select your desired board profile configuratioon
+(see: nuttx/sim/sim/sim/configs for the listing) ::
+
+    $ ./tools/configure.sh sim:nsh
+
+    $ make
+
+
+Running
+=======
+
+When the compilation finishes it will create a ``nuttx`` binary, then run it::
+
+    $ ./nuttx 
+    login: admin
+    password: Administrator
+    User Logged-in!
+
+    NuttShell (NSH) NuttX-10.1.0
+    MOTD: username=admin password=Administrator
+    nsh> ?
+    help usage:  help [-v] [<cmd>]
+
+      .         cd        echo      hexdump   mkfatfs   pwd       source    unset     
+      [         cp        exec      kill      mkrd      readlink  test      usleep    
+      ?         cmp       exit      losetup   mount     rm        time      xd        
+      basename  dirname   false     ln        mv        rmdir     true      
+      break     dd        free      ls        poweroff  set       uname     
+      cat       df        help      mkdir     ps        sleep     umount    
+
+    Builtin Apps:
+      sh     hello  nsh    
+    nsh> uname -a
+    NuttX 10.1.0 508215581f Sep  3 2021 10:47:34 sim sim
+    nsh>
+