Skip to content

Commit

Permalink
...
Browse files Browse the repository at this point in the history
  • Loading branch information
AdinAck committed Jul 29, 2024
1 parent 5729601 commit ee6010c
Show file tree
Hide file tree
Showing 51 changed files with 1,420 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.126.3
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
submodules: recursive
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.22'
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Setup Hugo
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Build with Hugo
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production
run: |
hugo \
--gc --minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./public

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Hugo output
public/
resources/
.hugo_build.lock

# Editor
.vscode/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Xin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ECE 196 Website

The ECE 196 website, visit [here](ece-196.github.io/site).
11 changes: 11 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: ECE 196 Technical Documentation
toc: false
---

{{< cards >}}
{{< card link="about" title="About" icon="information-circle" >}}
{{< card link="projects" title="Projects" icon="code" >}}
{{< card link="assignments" title="Assignments" icon="book-open" >}}
{{< card link="additional-resources" title="Resources" icon="external-link" >}}
{{< /cards >}}
8 changes: 8 additions & 0 deletions content/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: About
type: about
---

Karcher... about.

## Tutors
11 changes: 11 additions & 0 deletions content/additional-resources/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Resources
toc: false
---

Some useful external resources.

{{< cards >}}
{{< card link="arduino" title="Arduino" >}}
{{< card link="swiftui" title="SwiftUI" subtitle="Developing idiomatic SwiftUI apps and using BLE.">}}
{{< /cards >}}
7 changes: 7 additions & 0 deletions content/additional-resources/arduino.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Arduino
type: docs
---


TODO...
35 changes: 35 additions & 0 deletions content/additional-resources/swiftui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: SwiftUI
type: docs
---

![](https://developer.apple.com/assets/elements/icons/swiftui/swiftui-96x96_2x.png)
## Getting Started with SwiftUI - ECE 196

### What is SwiftUI?

**SwiftUI** is a framework for developing applications for any Apple device. SwiftUI is written in the language **Swift**, hence the name.

### Download XCode

XCode is the [IDE](https://www.codecademy.com/article/what-is-an-ide) that you will use to develop Swift apps.
XCode allows you to write code, preview your app, debug, and deploy to your Apple devices.

You can download XCode [here](https://developer.apple.com/xcode/).

### Resources
#### Official
- [Apple SwiftUI Tutorials](https://developer.apple.com/tutorials/swiftui)
- [SwiftUI Documentation](https://developer.apple.com/documentation/swiftui/)
- [Develop In Swift](https://developer.apple.com/tutorials/develop-in-swift/) (New!)

#### 3rd Party
- [Hacking with Swift - 100 Days of SwiftUI](https://www.hackingwithswift.com/100/swiftui): Will introduce you to the Swift language, then ease you into using SwiftUI.
- [Hacking with Swift - SwiftUI by Example](https://www.hackingwithswift.com/quick-start/swiftui): A large collection of SwiftUI idioms, examples of common things you may want to do.
- [SwiftOnTap](https://swiftontap.com): SwiftUI database, gifs showing off how SwiftUI components work and look.

## BLE

It is common for teams to want to develop an iOS app that communicates with their device via BLE.

An old EnVision tutorial for creating a simple RGB lamp can be found [here](https://github.com/AdinAck/EnVision-Tutorial-Lamp). This tutorial goes over setting up a Swift app to use BLE and writing Arduino BLE code for the device.
15 changes: 15 additions & 0 deletions content/assignments/ControlWithPython/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: ControlWIthPython
type: docs
prev: assignments/VUMeter/
next: assignments/ControlWithPython/tutorial
weight: 4
---

In this assignment you will learn to create a **G**raphical **U**ser **I**nterface (GUI) to interact with a microcontroller.

We will be migrating from CircuitPython to the Arduino C ecosystem.

Download the Arduino software [here](https://www.arduino.cc/en/software).

If you are unfamiliar with Arduino, the official [Arduino website](https://www.arduino.cc/reference/en/) contains great resources for learning about embedded development. You may also want to take a look at the [reference page](https://www.arduino.cc/reference/en/) for help with Arduino's syntax and language.
16 changes: 16 additions & 0 deletions content/assignments/ControlWithPython/quiz.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Quiz
type: docs
prev: assignments/ControlWithPython/tutorial
weight: 2
---

This assignment is the first to have a quiz!

You can find the quiz in the root directory of the assignment repo, named `QUIZ.md`. The questions are there, you just need to fill in the answers.

If you need hints, feel free to talk to the TAs.

{{< callout type="warning" >}}
You may discuss with your peers, but **do not** copy each other.
{{< /callout >}}
9 changes: 9 additions & 0 deletions content/assignments/ControlWithPython/submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Submission
type: docs
weight: 3
---

1. Completed code (in `app.py`).
1. Answers in `QUIZ.md`.
1. Video of LED being controlled by the Python GUI named `submission.*` placed in root of this repository.
Loading

0 comments on commit ee6010c

Please sign in to comment.