Update CI status badge

Fixed auto correct error for better readability. 
Changed, Pool SDK image, to Pull SDK image

.github/workflows/sdk-ci.yml

@@ -0,0 +1,47 @@
+name: Raspberry PI Pico Docker SDK CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types: [published]
+
+env:
+  TEST_TAG: pico_test_sdk
+
+jobs:
+  sdk_container:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build SDK
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          load: true
+          tags: ${{ env.TEST_TAG }}
+      - name: Test SDK
+        run: bash ./test_sdk.sh ${{ env.TEST_TAG }}
+      - name: Log into Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ github.actor }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+      - name: Extract SDK metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: lukstep/raspberry-pi-pico-sdk
+      - name: Push SDK image
+        if: github.event_name == 'release' && github.event.action == 'published'
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.16.2
+FROM alpine:3.17.0
 
 # Install toolchain
 RUN apk update && \
@@ -15,14 +15,14 @@ RUN apk update && \
 
 # Raspberry Pi Pico SDK
 ARG SDK_PATH=/usr/share/pico_sdk
-RUN git clone https://github.com/raspberrypi/pico-sdk $SDK_PATH && \
+RUN git clone --depth 1 --branch 1.5.1 https://github.com/raspberrypi/pico-sdk $SDK_PATH && \
     cd $SDK_PATH && \
     git submodule update --init
 
 ENV PICO_SDK_PATH=$SDK_PATH
 
 # Picotool installation
-RUN git clone -b master https://github.com/raspberrypi/picotool.git /home/picotool && \
+RUN git clone --depth 1 --branch 1.1.2 https://github.com/raspberrypi/picotool.git /home/picotool && \
     cd /home/picotool && \
     mkdir build && \
     cd build && \

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 lukstep
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,18 +1,23 @@
+[![Raspberry PI Pico Docker SDK CI](https://github.com/lukstep/raspberry-pi-pico-docker-sdk/actions/workflows/sdk-ci.yml/badge.svg)](https://github.com/lukstep/raspberry-pi-pico-docker-sdk/actions/workflows/sdk-ci.yml)
+
 # Raspberry Pi Pico Docker SDK
 
-## Run Docker container
+Lightweight Raspberry Pi Pico C++ SDK container.
 
+## Pull container from Docker Hub and run
+
+The latest version of the image is stored on [Docker Hub](https://hub.docker.com/repository/docker/lukstep/raspberry-pi-pico-sdk/general)
+and can be used for container runs.
+Commands below show how to run a container, using an image from Docker Hub
 ```
-docker build ./docker --tag pico-sdk
-
-docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev pico-sdk
+docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev lukstep/raspberry-pi-pico-sdk:latest
 
 docker exec -it pico-sdk /bin/sh
 ```
 
-## Project build
+The directory from which the `docker run` command was called will be mounted to /home/dev in the container. 
+So after attaching to the SDK container you can build your project following the steps:
 
-After attaching to SDK container run the following command to build the project:
 ```
 cd /home/dev
 
@@ -21,5 +26,116 @@ mkdir build
 cd build
 
 cmake .. && make -j4
+```
+
+## Build image and run container:
+
+To build your own SDK image, You need to clone this repository and run the following commands:
 
 ```
+cd raspberry-pi-pico-docker-sdk
+
+docker build . --tag pico-sdk
+
+docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev pico-sdk
+
+docker exec -it pico-sdk /bin/sh
+```
+
+## Visual Studio Code as Rassberry Pi PICO projects IDE
+
+You can use the SDK container with Visual Studio Code as Raspberry Pi Pico projects IDE. 
+
+### Attaching VSCode to SDK Docker container
+
+Follow the instruction below to set up VSCode:
+
+1. Install [Visual Studio Code](https://code.visualstudio.com) and next [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extensions.
+
+![image-1](https://user-images.githubusercontent.com/20487002/201380432-da387680-f6b0-4542-8c02-6a3eec8e103d.png)
+
+2. Open the terminal and go to the projects you want to open in VSCode.
+
+3. Pull SDK image from Docker HUB and run SDK container via the following command. The container must be running while you attach to it via VSCode.
+
+```
+docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev lukstep/raspberry-pi-pico-sdk:latest
+
+docker exec -it pico-sdk /bin/sh
+```
+
+4. When the container is launched, go to VSCode, click the green button in the lower left corner of VSCode and select options: Attach to Running Container...
+
+![image-2](https://user-images.githubusercontent.com/20487002/201471437-b12dc225-28ab-4ebd-b694-fc7058d34e2e.png)
+
+5. Select the SDK container.
+
+![image-4](https://user-images.githubusercontent.com/20487002/201383009-54a3fc62-1206-4105-83d0-d956448434dd.png)
+
+6. Then a new VSCode window will open. At the bottom window, you can see that it is attached to the SDK container.
+
+![image-5](https://user-images.githubusercontent.com/20487002/201383452-10573842-de2a-46c3-9ebf-f6fd5f06c687.png)
+
+7. Now, there is needed to open project files. Your project is mounted to `/home/dev` in the container. Go to EXPLORE tab in VSCode and click Open Folder. In opened window write `/home/dev` and click the OK button.
+
+![image-6](https://user-images.githubusercontent.com/20487002/201386202-dd0934b2-5fae-4a2d-8875-f2cb40b1dc59.png)
+
+8. Now You can explore, develop and build your Raspberry Pi Pico project via Visual Studio Code!
+
+![image-7](https://user-images.githubusercontent.com/20487002/201389505-d1346622-a8e1-4d0b-842c-57e5b54f9183.png)
+
+### Pico SDK aware Intellisense
+
+For an IntelliSense that will be aware of Raspberry Pi Pico SDK dependencies, we will use [Clangd](https://clangd.llvm.org). Clangd is a C/C++ language server provided by the LLVM project. To Setup Clang as Intellisense engine follow instruction below:
+
+1. To begin with, you need to install the server itself (Clangd is not installed by default in the SDK container image), to do this in the terminal call the command:
+
+```
+apk add clang-extra-tools
+```
+
+2. Next is needed to install the Visual Studio Code [Clangd extension](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd).
+
+![image-1](https://user-images.githubusercontent.com/20487002/201468256-be7741a2-9092-406a-8be1-d4d9640a85e7.png)
+
+1. To set-up The Clangd extension, in the project root directory, create folder .vcode with file settings.json. To settings.json past configuration from the snippet below:
+
+```json
+{
+    "C_Cpp.intelliSenseEngine": "Disabled",
+    "clangd.path": "/usr/bin/clangd",
+    "clangd.checkUpdates": false,
+    "clangd.restartAfterCrash": true,
+    "clangd.detectExtensionConflicts": true,
+    "clangd.arguments": ["-log=verbose", 
+                         "-pretty", 
+                         "--background-index", 
+                         "--query-driver=/usr/bin/arm-none-eabi-gcc",
+                         "--compile-commands-dir=/home/dev/build"]
+}
+```
+
+![image-2](https://user-images.githubusercontent.com/20487002/201468479-7de7e598-3aac-4fe4-a240-d7404200a0a6.png)
+
+
+4. For clangd to work, it needs a `compile_commands.json` file. This file contains the compilation and dependency information of each file in the project. To create it you need to add to the CMake command, `-DCMAKE_EXPORT_COMPILE_COMMANDS=1`.  So You need to build your project with the command:
+
+```
+mkdir build
+
+cd build 
+
+cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=1 .. 
+
+make
+```
+
+5. Now IntelliSense should work!. Now you should see a prompt when you start typing. If you hover your cursor over a function from the SDK you should see its documentation, You can go to the function definition by pressing F12.
+
+![image-3](https://user-images.githubusercontent.com/20487002/201469349-b8a9721f-4169-4bf6-a8d6-d459f8f97180.png)
+
+![image-4](https://user-images.githubusercontent.com/20487002/201468782-50fc6abb-1f82-49d5-8b93-631dd30f1f58.png)
+
+![image-5](https://user-images.githubusercontent.com/20487002/201468813-2ef7b04f-ede6-46cb-84e2-a40db595811d.png)
+
+

test_sdk.sh

@@ -0,0 +1,9 @@
+if [[ -z $1 ]]; then
+    echo "Please provide an SDK image you want to test"
+fi
+
+docker run -d -it --name pico-sdk --mount type=bind,source=${PWD}/test_poject,target=/home/dev $1
+docker exec pico-sdk /bin/sh -c "cd /home/dev && mkdir build && cd build && cmake .. && make -j4"
+docker exec pico-sdk /bin/sh -c "picotool"
+docker container kill pico-sdk
+docker container rm pico-sdk