starting point

SomeAspy · Aug 11, 2024 · 399f06f · 399f06f
1 parent 700837a
commit 399f06f
Show file tree

Hide file tree

Showing 17 changed files with 138 additions and 203 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,28 @@
+name: build
+on:
+  push:
+    branches:
+      - pages
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,2 @@
-config.cpp
-build
-.vscode/c_cpp_properties.json
-blank.txt
+.venv
+site
diff --git a/.markdownlint.yml b/.markdownlint.yml
@@ -0,0 +1,5 @@
+MD013: false # line-length
+MD033:
+    allowed_elements:
+      - figure
+      - figcaption
diff --git a/.vscode/arduino.json b/.vscode/arduino.json
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/ChromeBookEnroller.ino b/ChromeBookEnroller.ino
diff --git a/config.example.cpp b/config.example.cpp
diff --git a/docs/content/arduino-nano-every-taped.jpg b/docs/content/arduino-nano-every-taped.jpg
diff --git a/docs/content/arduino-nano-every.png b/docs/content/arduino-nano-every.png
diff --git a/docs/first-steps.md b/docs/first-steps.md
@@ -0,0 +1,36 @@
+# First steps
+
+To use this project, you need an [Arduino board](https://www.arduino.cc/en/hardware).
+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)
+  <figcaption>The Nano Every, as shown on Arduino's store</figcaption>
+</figure>
+
+There are a few reasons I suggest this over Arduino's other offerings:
+
+- **Pricing**: This is one of the cheapest offerings from Arduino
+- **Footprint**: This is one the smallest boards
+- **No Headers**: Headers are not pre-soldered to the board, further decreasing the footprint
+
+While I strongly suggest getting the original from [Arduino's site](https://store.arduino.cc/products/arduino-nano-every) or [Amazon](https://www.amazon.com/dp/B07VX7MX27), most knock-offs will work just fine.
+
+## Purchase
+
+- [Official Arduino Store](https://store.arduino.cc/products/arduino-nano-every) ([Bulk option](https://store.arduino.cc/products/arduino-nano-every-pack?variant=40377141887183))
+  - [Tax exemption and quotation information](https://store-usa.arduino.cc/pages/how-to-buy)
+- [Arduino's Official Amazon Listing](https://www.amazon.com/dp/B07VX7MX27)
+- [Other authorized Arduino distributors](https://store.arduino.cc/pages/distributors)
+
+## Protection
+
+!!! warning
+
+    While not required, I suggest wrapping them in a single layer of tape, to avoid shorting during use.
+    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)
+  <figcaption>One of our Arduino Nano knock-offs, with tape protecting the electronics</figcaption>
+</figure>
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,14 @@
+# Overview
+
+This documentation is divided into several section for readability and maintainability.
+You can skip between them at any time using the navigation on the left.
+
+## Sections
+
+### 1. [First Steps](./first-steps.md)
+
+Purchasing & protecting boards
+
+### 2. [Setup](./setup.md)
+
+Programming boards
diff --git a/docs/setup.md b/docs/setup.md
@@ -0,0 +1 @@
+# Setup
diff --git a/keys.cpp b/keys.cpp
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,23 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+site_name: ChromeBookEnroller
+site_url: https://cbe.github.aspy.dev
+repo_url: https://github.com/SomeAspy/ChromeBookEnroller
+theme:
+  name: material
+  palette: 
+    scheme: slate
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+    - navigation.instant
+    - navigation.tracking
+
+plugins:
+  - search
+
+markdown_extensions:
+  - admonition
+  - md_in_html
diff --git a/readme.md b/readme.md
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,29 @@
+babel==2.16.0
+certifi==2024.7.4
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+ghp-import==2.1.0
+idna==3.7
+Jinja2==3.1.4
+Markdown==3.6
+MarkupSafe==2.1.5
+mergedeep==1.3.4
+mkdocs==1.6.0
+mkdocs-get-deps==0.2.0
+mkdocs-material==9.5.31
+mkdocs-material-extensions==1.3.1
+packaging==24.1
+paginate==0.5.6
+pathspec==0.12.1
+platformdirs==4.2.2
+Pygments==2.18.0
+pymdown-extensions==10.9
+python-dateutil==2.9.0.post0
+PyYAML==6.0.2
+pyyaml_env_tag==0.1
+regex==2024.7.24
+requests==2.32.3
+six==1.16.0
+urllib3==2.2.2
+watchdog==4.0.2