Skip to content

Commit

Permalink
docs: update README with GitHub Actions badge and reorganize content
Browse files Browse the repository at this point in the history
  • Loading branch information
dawidrylko committed Jul 7, 2024
1 parent 7f2d723 commit 4863056
Showing 1 changed file with 34 additions and 26 deletions.
60 changes: 34 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 🦡 Badger 2040

[![Python Linting](https://github.com/dawidrylko/badger2040/actions/workflows/python-linting.yml/badge.svg)](https://github.com/dawidrylko/badger2040/actions/workflows/python-linting.yml)

> A programmable badge with fast updating E Ink® display and wireless connectivity, powered by Raspberry Pi Pico W.
## 📖 Overview
Expand All @@ -10,9 +12,29 @@ This repository provides several example projects that demonstrate the capabilit

The examples in this repository are organized into different categories based on their functionality. Each category contains a set of examples that demonstrate a specific feature or use case of the Badger 2040.

### ⚙️ Actions

The Actions examples demonstrate how to display GitHub Actions workflows directly on the Badger 2040. This includes processing button presses to navigate through different workflows, viewing their statuses, and updating the E Ink display with the relevant information.

<!-- TODO: add photo of the example -->

```plaintext
badger_os/
├── examples/
│ ├── actions.py
│ └── icon-actions.png
└── GITHUB_CONFIG.py
```

- `actions.py`: Demonstrates how to define and handle various user actions, such as button presses, to trigger different functionalities and update the display accordingly.
- `icon-actions.png`: Icon representing actions within the system.
- `GITHUB_CONFIG.py`: Configuration file for GitHub Actions, useful for setting up automation or CI/CD processes related to the project.

### ✨ Configuration Restoration

Easily restore WiFi and GitHub configurations with the new configuration restoration feature:
The configuration restoration feature allows you to easily restore WiFi and GitHub settings to your Badger 2040. This is particularly useful for quickly switching between different network environments or resetting configurations to a known state.

<!-- TODO: add photo of the example -->

```plaintext
badger_os/
Expand All @@ -27,45 +49,31 @@ badger_os/
└── GITHUB_WORK.py
```

- `config_restore.py`: Main script to handle restoration of WiFi and GitHub configurations.
- `WIFI_HOME.py`, `WIFI_WORK.py`, `WIFI_HOTSPOT.py`: Default WiFi configuration files.
- `GITHUB_HOME.py`, `GITHUB_WORK.py`: Default GitHub configuration files.
- `restore.py`: Main script to handle restoration of WiFi and GitHub configurations by pressing a button on the Badger 2040.
- `WIFI_HOME.py`, `WIFI_WORK.py`, `WIFI_HOTSPOT.py`: Default WiFi configuration files for different environments.
- `GITHUB_HOME.py`, `GITHUB_WORK.py`: Default GitHub configuration files for different environments.

Simply press the appropriate button on the Badger 2040 to restore the corresponding configuration.

### 🌐 WiFi

Explore the wireless connectivity capabilities of the Badger 2040 with the following examples:
The WiFi examples demonstrate how to utilize the Badger 2040's wireless capabilities. You can learn how to connect to a WiFi network, perform network operations, and interact with web content.

<!-- TODO: add photo of the example -->

```plaintext
badger_os/
├── examples/
│ ├── icon-wifi.png
│ └── wifi.py
│ ├── wifi.py
│ └── icon-wifi.png
└── pages/
├── wifi-setup-successful.html
└── wifi-setup.html
```

- `wifi.py`: Demonstrates how to connect the Badger 2040 to a WiFi network and perform basic network operations.
- `wifi-setup.html`: HTML page for setting up the WiFi connection.
- `wifi-setup-successful.html`: HTML page displayed upon successful WiFi connection.

### ⚙️ Actions

Learn how to handle different actions on the Badger 2040 with these examples:

```plaintext
badger_os/
├── examples/
│ ├── actions.py
│ └── icon-actions.png
└── GITHUB_CONFIG.py
```

- `actions.py`: Shows how to define and handle various user actions, such as button presses and screen updates.
- `icon-actions.png`: Icon representing actions within the system.
- `GITHUB_CONFIG.py`: Configuration file for GitHub Actions, if any automation or CI/CD processes are set up.
- `wifi.py`: Script to connect the Badger 2040 to a WiFi network and perform basic network operations like fetching data from the web.
- `wifi-setup.html`: HTML page for setting up the WiFi connection via a web interface.
- `wifi-setup-successful.html`: HTML page displayed upon a successful WiFi connection setup.

## 📋 Requirements

Expand Down

0 comments on commit 4863056

Please sign in to comment.