How to build

Author: lupyuen

README.md

@@ -1 +1,88 @@
-# nshtask
+# Apache NuttX RTOS: NSH Task Demo
+
+To build and run this NSH Demo App...
+
+1.  Install the Build Prerequisites, skip the RISC-V Toolchain...
+
+    ["Install Prerequisites"](https://lupyuen.github.io/articles/nuttx#install-prerequisites)
+
+1.  Download the ARM64 Toolchain for
+    AArch64 Bare-Metal Target `aarch64-none-elf`
+    
+    [Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
+
+    (Skip the section for Beta Releases)
+
+1.  Add the downloaded toolchain to the `PATH` Environment Variable...
+
+    ```text
+    gcc-arm-...-aarch64-none-elf/bin
+    ```
+
+    Check the ARM64 Toolchain...
+
+    ```bash
+    aarch64-none-elf-gcc -v
+    ```
+
+1.  Download NuttX...
+
+    ```bash
+    mkdir nuttx
+    cd nuttx
+    git clone https://github.com/apache/nuttx nuttx
+    git clone https://github.com/apache/nuttx-apps apps
+    cd nuttx
+    ```
+
+1.  Add `nshtask` to our NuttX Project...
+
+    ```bash
+    pushd ../apps/examples
+    git submodule add https://github.com/lupyuen/nshtask
+    popd
+    ```
+
+1.  Configure our NuttX Project...
+
+    ```bash
+    tools/configure.sh -l qemu-armv8a:nsh
+    make menuconfig
+    ```
+
+1.  In "Application Configuration > Examples"
+
+    Enable "NSH Task Demo"
+
+1.  Optional: If we wish to start `nshtask` when NuttX boots...
+
+    In "RTOS Features > Tasks and Scheduling"
+
+    Set "Application entry point" to `nshtask_main`
+
+    Set "Application entry name" to `nshtask_main`
+
+1.  Save the configuration and exit `menuconfig`
+
+1.  Build NuttX...
+
+    ```bash
+    make
+    ```
+
+1.  Run with QEMU...
+
+    ```bash
+    qemu-system-aarch64 -cpu cortex-a53 -nographic \
+      -machine virt,virtualization=on,gic-version=3 \
+      -net none -chardev stdio,id=con,mux=on -serial chardev:con \
+      -mon chardev=con,mode=readline -kernel ./nuttx
+    ```
+
+1.  At the NSH Prompt, enter...
+
+    ```bash
+    nshtask
+    ```
+
+1.  Press Ctrl-C to quit QEMU