Skip to content

Commit

Permalink
Add template usage graphical instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
milosz275 committed Oct 30, 2024
1 parent a4c6082 commit 87a1820
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

This is a template for a Pico W project. It includes a basic project structure and a simple example of a Pico W application in C using pico-sdk and pico-extras. Feel free to use it if CMake is is challenging for you or you just want to get started quickly.

To use this template click "Use this template" and create a new repository or open the template in a codespaces [or use this template here](https://github.com/new?template_name=pico-w-template&template_owner=milosz275).

- [GitHub repository](https://github.com/milosz275/pico-w-template)
- [Doxygen documentation](https://milosz275.github.io/pico-w-template/)

Expand All @@ -25,6 +23,19 @@ To use this template click "Use this template" and create a new repository or op

## Getting Started

To use this template click "Use this template" and create a new repository or open the template in a codespaces [or use this template here](https://github.com/new?template_name=pico-w-template&template_owner=milosz275).

![use template screen](assets/use-template.png)

After the repository is recreated, please modify repo settings in order to GitHub Pages docs deploy workflow succeed. Select GitHub Actions as a source for build and deployment.

> [!IMPORTANT]
> Even if your repository is private, deployed docs will be available publicly.
![github pages](assets/pages-settings.png)

CodeQL might not work for private repositories. If you want to use it, you need to enable it in the repository settings, else remove the workflow.

### Prerequisites

It might be necessary to install additional dependencies to build the project. The following commands install the required dependencies on Ubuntu:
Expand Down
Binary file added assets/pages-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/use-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 87a1820

Please sign in to comment.