Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SomeAspy committed Aug 11, 2024
1 parent 0c73263 commit ce0ea42
Show file tree
Hide file tree
Showing 9 changed files with 66 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Deploy
on:
push:
branches:
- pages
- docs
jobs:
build:
runs-on: ubuntu-latest
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.venv
site
site
.cache
File renamed without changes
File renamed without changes
Binary file added docs/content/setup/branch-list.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 docs/content/setup/download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To use this project, you need an [Arduino board](https://www.arduino.cc/en/hardw
Realistically, any will work, but I strongly suggest getting the [Arduino Nano Every](https://store.arduino.cc/products/arduino-nano-every).

<figure markdown="span">
![Arduino Nano Every](./content/arduino-nano-every.png)
![Arduino Nano Every](./content/first-steps/arduino-nano-every.png)
<figcaption>The Nano Every, as shown on Arduino's store</figcaption>
</figure>

Expand All @@ -31,6 +31,6 @@ While I strongly suggest getting the original from [Arduino's site](https://stor
If you end up doing this, I also suggest using a clear tape, so the LEDs can shine through.

<figure markdown="span">
![Arduino Nano knock-off, with tape](./content/arduino-nano-every-taped.jpg)
![Arduino Nano knock-off, with tape](./content/first-steps/arduino-nano-every-taped.jpg)
<figcaption>One of our Arduino Nano knock-offs, with tape protecting the electronics</figcaption>
</figure>
58 changes: 58 additions & 0 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -1 +1,59 @@
# Setup

## Installing the Arduino IDE

[Install the Arduino IDE](https://www.arduino.cc/en/software)

## Download the code

### With Git

!!! info
If you do not know what Git is, or do not have it installed, you should skip to [Without Git](#without-git)

```bash
git clone https://github.com/SomeAspy/ChromeBookEnroller
cd ChromeBookEnroller
git branch -r
```
Switch to the branch closest to your ChromeBook's version.

---

### Without Git

1. Navigate to the list of branches in the repository:

<https://github.com/SomeAspy/ChromeBookEnroller/branches/all>

2. Select the closest version to what your ChromeBooks are running

<figure markdown="span">
![List of branches in the repository](./content/setup/branch-list.png)
<figcaption>List of branches in the repository</figcaption>
</figure>

3. Press the green "Code" button and select "Download ZIP"

<figure markdown="span">
![Downloading the code ZIP](./content/setup/download.png)
<figcaption>Downloading the code ZIP</figcaption>
</figure>

4. Download and extract the ZIP.

5. Name the folder `ChromeBookEnroller`

!!! failure
This step is actually crucial, as otherwise the Arduino IDE will throw an error because the project name does not match the directory name.

The file structure should look similar to this:

```txt
ChromeBookEnroller
├── ChromeBookEnroller.ino
├── config.example.cpp
├── keys.cpp
├── license.txt
└── readme.md
```
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
site_name: ChromeBookEnroller
site_url: https://cbe.github.aspy.dev
repo_url: https://github.com/SomeAspy/ChromeBookEnroller
copyright: Copyright &copy; 2024 Aiden B. (SomeAspy)
theme:
name: material
palette:
Expand All @@ -14,6 +15,8 @@ theme:
- search.share
- navigation.instant
- navigation.tracking
- content.code.copy
- content.action.view

plugins:
- search
Expand Down

0 comments on commit ce0ea42

Please sign in to comment.