first commit.

docs/README.md

@@ -0,0 +1,77 @@
+# network_monitor_esp_rs
+
+## Dev Containers
+This repository offers Dev Containers supports for:
+-  [VS Code Dev Containers](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container)
+-  [GitHub Codespaces](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace)
+> **Note**
+>
+> In [order to use GitHub Codespaces](https://github.com/features/codespaces#faq)
+> the project needs to be published in a GitHub repository and the user needs
+> to be part of the Codespaces beta or have the project under an organization.
+
+If using VS Code or GitHub Codespaces, you can pull the image instead of building it
+from the Dockerfile by selecting the `image` property instead of `build` in
+`.devcontainer/devcontainer.json`. Further customization of the Dev Container can
+be achived, see [.devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference).
+
+When using Dev Containers, some tooling to facilitate building, flashing and
+simulating in Wokwi is also added.
+### Build
+- Terminal approach:
+
+    ```
+    scripts/build.sh  [debug | release]
+    ```
+    > If no argument is passed, `release` will be used as default
+
+
+-  UI approach:
+
+    The default build task is already set to build the project, and it can be used
+    in VS Code and GitHub Codespaces:
+    - From the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`Ctrl-Shift-P` or `Cmd-Shift-P`) run the `Tasks: Run Build Task` command.
+    - `Terminal`-> `Run Build Task` in the menu.
+    - With `Ctrl-Shift-B` or `Cmd-Shift-B`.
+    - From the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`Ctrl-Shift-P` or `Cmd-Shift-P`) run the `Tasks: Run Task` command and
+    select `Build`.
+    - From UI: Press `Build` on the left side of the Status Bar.
+
+### Flash
+
+> **Note**
+>
+> When using GitHub Codespaces, we need to make the ports
+> public, [see instructions](https://docs.github.com/en/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace#sharing-a-port).
+
+- Terminal approach:
+  - Using `flash.sh` script:
+
+    ```
+    scripts/flash.sh [debug | release]
+    ```
+    > If no argument is passed, `release` will be used as default
+
+- UI approach:
+    - From the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`Ctrl-Shift-P` or `Cmd-Shift-P`) run the `Tasks: Run Task` command and
+    select `Build & Flash`.
+    - From UI: Press `Build & Flash` on the left side of the Status Bar.
+- Any alternative flashing method from host machine.
+
+
+### Wokwi Simulation
+
+#### VS Code Dev Containers and GitHub Codespaces
+
+The Dev Container includes the Wokwi Vs Code installed, hence you can simulate your built projects doing the following:
+1. Press `F1`
+2. Run `Wokwi: Start Simulator`
+
+> **Note**
+>
+>  We assume that the project is built in `debug` mode, if you want to simulate projects in release, please update the `elf` and  `firmware` proprieties in `wokwi.toml`.
+
+For more information and details on how to use the Wokwi extension, see [Getting Started] and [Debugging your code] Chapter of the Wokwi documentation.
+
+[Getting Started]: https://docs.wokwi.com/vscode/getting-started
+[Debugging your code]: https://docs.wokwi.com/vscode/debugging