Skip to content

Commit

Permalink
chore: License and Notices for public release
Browse files Browse the repository at this point in the history
Includes

fix: update .gitignore for cache files
remove old `TODO.md` before public release
fix: license and notices generally have no extension
  • Loading branch information
jclds139 committed Oct 2, 2024
1 parent f16e2a3 commit 39364bf
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 12 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -273,3 +273,7 @@ compile_commands.json

# CCLS
.ccls-cache/

## Local Additions
.cache/
.vscode/
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,9 @@ repos:
- id: trailing-whitespace
- id: check-added-large-files
- id: end-of-file-fixer
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v3.4.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: []
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) 2024 The Regents of the University of Michigan, PEI Lab

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.
1 change: 1 addition & 0 deletions NOTICES
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Copyright 2024 The Regents of the University of Michigan, PEI Lab
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# [GeoMCU](https://github.com/NohPei/GeoMCU) Firmware

Arduino® firmware for running [GeoMCU](https://github.com/NohPei/GeoMCU) receiver boards.

In-depth documentation is included with the [GeoMCU Documentation](https://geomcu.readthedocs.io)

## Building

This project is set up to be compiled and flashed using [PlatformIO](https://platformio.org/), whether through the IDE or the core CLI.

Building with the [Arduino IDE](https://www.arduino.cc/en/software) should be possible, but is unsupported.
Doing so would require manually installing libraries and some modifications to link with the included `lib` folder.


Copyright © 2024 The Regents of the University of Michigan, [PEI Lab](https://peizhang.engin.umich.edu/)
9 changes: 0 additions & 9 deletions TODO.md

This file was deleted.

7 changes: 4 additions & 3 deletions geoscope/geoscope.ino
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
/*
Name: geoscope.ino
Created: 6/13/2018 1:34:31 PM
Author: Sripong
Name: geoscope.ino
Original Created: 6/13/2018 1:34:31 PM
Original Author: Sripong Ariyadech (liurln)
Updated: 02 Oct 2024
*/

// the setup function runs once when you press reset or power the board
Expand Down

0 comments on commit 39364bf

Please sign in to comment.