mirror of
https://github.com/librekeys/picoforge.git
synced 2026-07-28 08:01:19 -07:00
chore(docs): update readme.md and PR template
This commit is contained in:
@@ -1,17 +1,14 @@
|
||||
<!--# Pull Request Process-->
|
||||
<!--PicoForge Pull Request Template-->
|
||||
|
||||
<!--
|
||||
## Before submitting a pull request
|
||||
Please ensure that any install or build dependencies are removed before the end of the layer when doing a build, and verify that your code compiles successfully.
|
||||
|
||||
## General steps for completing this pull request
|
||||
Please review the [guidelines for contributing](CONTRIBUTING.md) to this repository before proceeding. Check [README.md](../README.md) to get more info of the project.
|
||||
-->
|
||||
<!-- This note should be removed from the template when submitting a pull request. -->
|
||||
> [!NOTE]
|
||||
> Please review the [guidelines for contributing](CONTRIBUTING.md) to this repository before proceeding. Check [README.md](../README.md) to get more info of the project.
|
||||
|
||||
### Checklist
|
||||
|
||||
Ensure that your pull request has followed all the steps below:
|
||||
|
||||
<!-- Remove any optional items that do not apply to your pull request. -->
|
||||
- [ ] Code compiles without errors
|
||||
- [ ] Code is formatted using `cargo fmt`
|
||||
- [ ] All tests are passing (skip if no tests exist)
|
||||
@@ -32,6 +29,7 @@ Why should this pull request be accepted? What problem does it solve?
|
||||
|
||||
Please check the relevant types of changes this PR introduces:
|
||||
|
||||
<!-- Only keep the items that apply to your pull request. -->
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
|
||||
@@ -19,6 +19,9 @@
|
||||
> This software does not share any code with the official closed-source pico-fido application.
|
||||
>
|
||||
> Check application [Installation Wiki](https://github.com/librekeys/picoforge/wiki/Installation) for installation guide of the PicoForge app on your system.
|
||||
>
|
||||
> PicoForge only supports v7.2 of the PICO FIDO series of firmwares. Support to v7.4 and above
|
||||
> is WIP.
|
||||
|
||||
## About
|
||||
|
||||
@@ -31,7 +34,7 @@ PicoForge is a modern desktop application for configuring and managing Pico FIDO
|
||||
- Real-time system logging and diagnostics
|
||||
- Support for multiple hardware variants and vendors
|
||||
|
||||
> **Alpha Status**: This application is currently under active development and in alpha stage. Users should expect bugs and are encouraged to report them. The app has been tested on Linux and Windows 10 with the official Raspberry Pi Pico2 & ESP32-S3 and, currently supports Pico FIDO firmware version 7.2 only.
|
||||
> **BETA Status**: This application is currently under active development and in beta stage. Users should expect bugs and are encouraged to report them. The app has been tested on Linux and Windows 10 with the official Raspberry Pi Pico2 & ESP32-S3 and, currently supports Pico FIDO firmware version 7.2 only.
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 33 KiB |
Reference in New Issue
Block a user