mirror of
https://github.com/EyeTrackVR/EyeTrackVR.git
synced 2025-09-26 23:09:28 +08:00
update - add files to prepare for professional looking github
This commit is contained in:
parent
8ecbe1e2bf
commit
e317dec8ac
80
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
Normal file
80
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
---
|
||||||
|
name: Problem Report
|
||||||
|
about: Create a Report to help us improve
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- Thanks for reporting a problem for this project. READ THIS FIRST:
|
||||||
|
|
||||||
|
This issue template is meant to REPORT EyeTrackVR software PROBLEMS ONLY
|
||||||
|
|
||||||
|
Please DO NOT OPEN AN ISSUE:
|
||||||
|
- If your EyeTrackVR version is not the latest from the development branch, please update your device before submitting your issue. Your problem might already be solved. The latest precompiled binaries of EyeTrackVR can be downloaded from https://redhawk989.github.io/EyeTrackVR/OTA/
|
||||||
|
- If your issue is a flashing issue, please address it to the [EyeTrackVR Support Chat](https://redhawk989.github.io/EyeTrackVR/contact/)
|
||||||
|
- If your issue is compilation problem, please address it to the [EyeTrackVR Support Chat](https://redhawk989.github.io/EyeTrackVR/contact/)
|
||||||
|
- If your issue has been addressed before (i.e., duplicated issue), please ask in the original issue
|
||||||
|
- If your issue is a Wi-Fi problem or MQTT problem, please try the steps provided in the [FAQ](https://redhawk989.github.io/EyeTrackVR/FAQ) and [Troubleshooting](https://redhawk989.github.io/EyeTrackVR/Troubleshooting)
|
||||||
|
|
||||||
|
Please take a few minutes to complete the requested information below. Our ability to provide assistance is greatly hampered without it. The details requested potentially affect which options to pursue. The small amount of time you spend completing the template will also help the volunteers providing the assistance to you to reduce the time required to help you.
|
||||||
|
|
||||||
|
DO NOT DELETE ANY TEXT from this template! Otherwise the issue will be auto-closed.
|
||||||
|
-->
|
||||||
|
|
||||||
|
### PROBLEM DESCRIPTION
|
||||||
|
_A clear and concise description of what the problem is._
|
||||||
|
|
||||||
|
|
||||||
|
### REQUESTED INFORMATION
|
||||||
|
_Make sure your have performed every step and checked the applicable boxes before submitting your issue. Thank you!_
|
||||||
|
|
||||||
|
- [ ] Read the [Contributing Guide and Policy](https://github.com/RedHawk989/EyeTrackVR/repo-tools/CONTRIBUTING.md) and [the Code of Conduct](https://github.com/RedHawk989/EyeTrackVR/CODE_OF_CONDUCT.md)
|
||||||
|
- [ ] Searched the problem in [issues](https://github.com/RedHawk989/EyeTrackVR/issues)
|
||||||
|
- [ ] Searched the problem in [discussions](https://github.com/RedHawk989/EyeTrackVR/discussions)
|
||||||
|
- [ ] Searched the problem in the [docs](https://redhawk989.github.io/EyeTrackVR/FAQ)
|
||||||
|
- [ ] Searched the problem in the [chat](https://redhawk989.github.io/EyeTrackVR/contact/)
|
||||||
|
- [ ] Device used (e.g., ESP32): _____
|
||||||
|
- [ ] EyeTrackVR binary firmware version number used: _____
|
||||||
|
- [ ] Pre-compiled
|
||||||
|
- [ ] Self-compiled
|
||||||
|
- [ ] Flashing tools used: _____
|
||||||
|
- [ ] Provide the output of command: `Backlog Template; Module; GPIO 255`:
|
||||||
|
```lua
|
||||||
|
Configuration output here:
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
- [ ] If using rules, provide the output of this command: `Backlog Rule1; Rule2; Rule3`:
|
||||||
|
```lua
|
||||||
|
Rules output here:
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
- [ ] Provide the output of this command: `Status 0`:
|
||||||
|
```lua
|
||||||
|
STATUS 0 output here:
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
- [ ] Set `weblog` to 4 and then, when you experience your issue, provide the output of the Console log:
|
||||||
|
```lua
|
||||||
|
Console output here:
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### TO REPRODUCE
|
||||||
|
_Steps to reproduce the behavior:_
|
||||||
|
|
||||||
|
|
||||||
|
### EXPECTED BEHAVIOUR
|
||||||
|
_A clear and concise description of what you expected to happen._
|
||||||
|
|
||||||
|
|
||||||
|
### SCREENSHOTS
|
||||||
|
_If applicable, add screenshots to help explain your problem._
|
||||||
|
|
||||||
|
|
||||||
|
### ADDITIONAL CONTEXT
|
||||||
|
_Add any other context about the problem here._
|
||||||
|
|
||||||
|
|
||||||
|
**(Please, remember to close the issue when the problem has been addressed)**
|
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: EyeTrackVR Docs
|
||||||
|
url: https://redhawk989.github.io/EyeTrackVR/
|
||||||
|
about: All the information related to EyeTrackVR.
|
||||||
|
- name: EyeTrackVR Discussions and Support
|
||||||
|
url: https://github.com/RedHawk989/EyeTrackVR/discussions
|
||||||
|
about: EyeTrackVR usage Questions, Feature Requests and Projects.
|
||||||
|
- name: EyeTrackVR Users Chat
|
||||||
|
url: https://redhawk989.github.io/EyeTrackVR/contact/
|
||||||
|
about: Chat for feedback, questions and troubleshooting.
|
13
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
13
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Description
|
||||||
|
|
||||||
|
**Related issue (if applicable):** fixes #<EyeTrackVR issue number goes here>
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] The pull request is done against the latest development branch
|
||||||
|
- [ ] Only relevant files were touched
|
||||||
|
- [ ] Only one feature/fix was added per PR and the code change compiles without warnings
|
||||||
|
- [ ] The code change is tested and works with EyeTrackVR core ESP32 newest release
|
||||||
|
- [ ] I accept the [CLA](hhttps://github.com/RedHawk989/EyeTrackVR/repo-tools/CONTRIBUTING.md#contributor-license-agreement-cla).
|
||||||
|
|
||||||
|
_NOTE: The code change must pass CI tests. **Your PR cannot be merged unless tests pass**_
|
11
.github/config.yml
vendored
Normal file
11
.github/config.yml
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# Configuration for sentiment-bot - https://github.com/behaviorbot/sentiment-bot
|
||||||
|
|
||||||
|
# *Required* toxicity threshold between 0 and .99 with the higher numbers being the most toxic
|
||||||
|
# Anything higher than this threshold will be marked as toxic and commented on
|
||||||
|
sentimentBotToxicityThreshold: .7
|
||||||
|
|
||||||
|
# *Required* Comment to reply with
|
||||||
|
sentimentBotReplyComment: >
|
||||||
|
Please be sure to review the code of conduct and be respectful of other users.
|
||||||
|
|
||||||
|
# Note: the bot will only work if your repository has a Code of Conduct
|
48
.github/issue-close-app.yml
vendored
Normal file
48
.github/issue-close-app.yml
vendored
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
# CLOSE ISSUE BOT
|
||||||
|
# ---------------
|
||||||
|
# A bot which helps you to close issues that don't include some specific contents.
|
||||||
|
# See how to use it in https://github.com/offu/close-issue-app.
|
||||||
|
|
||||||
|
# Comment that will be sent if an issue is judged to be closed.
|
||||||
|
comment: >-
|
||||||
|
This issue has been automatically closed because the PROBLEM REPORT TEMPLATE is missing or incomplete.
|
||||||
|
|
||||||
|
Filling the template is required so standard questions don't need to be asked again each time.
|
||||||
|
Our ability to provide assistance is greatly hampered if few minutes are not taken to complete the issue template
|
||||||
|
with the requested information. The details requested potentially affect which options to pursue. The small amount
|
||||||
|
of time you will spend completing the template will also help the volunteers, providing assistance to you, to reduce
|
||||||
|
the time required to help you.
|
||||||
|
|
||||||
|
Please, could you be so kind on completing the [PROBLEM REPORT TEMPLATE](https://github.com/RedHawk989/EyeTrackVR/issues/new/choose) in order to have more information so as to properly help you?
|
||||||
|
|
||||||
|
Thank you for taking the time to report, hopefully it can be resolved soon.
|
||||||
|
|
||||||
|
[Discussions](https://github.com/RedHawk989/EyeTrackVR/discussions) for Questions, Feature Requests and Projects.
|
||||||
|
|
||||||
|
[Chat](https://redhawk989.github.io/EyeTrackVR/contact/) for more users experience.
|
||||||
|
|
||||||
|
Please check the [Code of Conduct](hhttps://github.com/RedHawk989/EyeTrackVR/CODE_OF_CONDUCT.md) and the [Contributing Guideline and Policy](https://github.com/RedHawk989/EyeTrackVR/repo-tools/CONTRIBUTING.md)
|
||||||
|
|
||||||
|
issueConfigs:
|
||||||
|
# There can be several configs for different kind of issues.
|
||||||
|
- content:
|
||||||
|
# template 1: bug report
|
||||||
|
- "PROBLEM DESCRIPTION"
|
||||||
|
- "REQUESTED INFORMATION"
|
||||||
|
- "TO REPRODUCE"
|
||||||
|
- "EXPECTED BEHAVIOUR"
|
||||||
|
- content:
|
||||||
|
# template 2: feature request
|
||||||
|
- "Have you looked for this feature in other issues and in the docs"
|
||||||
|
- "Describe the solution you'd like"
|
||||||
|
|
||||||
|
# Optional configuration:
|
||||||
|
#
|
||||||
|
# whether the keywords are case-insensitive
|
||||||
|
# default value is false, which means keywords are case-sensitive
|
||||||
|
caseInsensitive: true
|
||||||
|
# the label that will be added when the bot close an issue
|
||||||
|
# The bot will only add a label if this property is set.
|
||||||
|
label: "template missing/incomplete"
|
||||||
|
# The issue is judged to be legal if it includes all keywords from any of these two configs.
|
||||||
|
# Or it will be closed by the app.
|
9
.github/workflows/README.md
vendored
Normal file
9
.github/workflows/README.md
vendored
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# Instructions
|
||||||
|
|
||||||
|
Please rename the `.github/workflows/<name>.txt` file of the workflow you wish to enable to `.github/workflows/<name>.yml`.
|
||||||
|
|
||||||
|
This file should be formatted as YAML, feel free to change the variables in the file. Please follow the [workflow documentation](https://docs.github.com/en/actions) for more information. [Learn more about workflows](https://docs.github.com/en/actions/using-workflows).
|
||||||
|
|
||||||
|
Please note that the workflows will be enabled automatically after you push your changes to the repository, and can always be enabled manually from the `Workflows` section of the repository settings.
|
||||||
|
|
||||||
|
Please ***do not delete*** the `.github/workflows/<name>.txt` files, and do not delete the `.github/workflows/build-jekyll.yml` file.
|
29
.github/workflows/build-jekyll.yml
vendored
Normal file
29
.github/workflows/build-jekyll.yml
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
name: Build and Deploy to Github Pages
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [docs]
|
||||||
|
|
||||||
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
# Use GitHub Actions' cache to cache dependencies on servers
|
||||||
|
- uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: vendor/bundle
|
||||||
|
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-gems-
|
||||||
|
|
||||||
|
# Use GitHub Deploy Action to build and deploy to Github
|
||||||
|
- uses: jeffreytse/jekyll-deploy-action@v0.3.1
|
||||||
|
with:
|
||||||
|
provider: 'github'
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }} # It's your Personal Access Token(PAT)
|
||||||
|
jekyll_src: './docs' # Default is root directory
|
92
.github/workflows/build_all_the_things.txt
vendored
Normal file
92
.github/workflows/build_all_the_things.txt
vendored
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
name: Tasmota CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
pull_request:
|
||||||
|
branches: development
|
||||||
|
paths:
|
||||||
|
- '**.c'
|
||||||
|
- '**.cpp'
|
||||||
|
- '**.h'
|
||||||
|
- '**.hpp'
|
||||||
|
- '**.ino'
|
||||||
|
- '**.json'
|
||||||
|
- '**.properties'
|
||||||
|
- 'pio-tools/*.py'
|
||||||
|
- '**.ini'
|
||||||
|
- '.github/workflows/build_all_the_things.yml'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
base-images:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
variant:
|
||||||
|
- tasmota
|
||||||
|
- tasmota4M
|
||||||
|
- tasmota-display
|
||||||
|
- tasmota-ir
|
||||||
|
- tasmota-knx
|
||||||
|
- tasmota-lite
|
||||||
|
- tasmota-minimal
|
||||||
|
- tasmota-sensors
|
||||||
|
- tasmota-zbbridge
|
||||||
|
- tasmota-zigbee
|
||||||
|
- tasmota32
|
||||||
|
- tasmota32-webcam
|
||||||
|
- tasmota32-bluetooth
|
||||||
|
- tasmota32-core2
|
||||||
|
- tasmota32-display
|
||||||
|
- tasmota32-ir
|
||||||
|
- tasmota32-lvgl
|
||||||
|
- tasmota32s2
|
||||||
|
- tasmota32c3
|
||||||
|
- tasmota32c3usb
|
||||||
|
- tasmota32solo1
|
||||||
|
- tasmota32solo1-safeboot
|
||||||
|
- tasmota32-safeboot
|
||||||
|
- tasmota32c3-safeboot
|
||||||
|
- tasmota32c3usb-safeboot
|
||||||
|
- tasmota32s2-safeboot
|
||||||
|
- tasmota32s3-safeboot
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v1
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
#python -m pip install --upgrade pip
|
||||||
|
pip install -U platformio
|
||||||
|
#platformio upgrade --dev
|
||||||
|
#platformio update
|
||||||
|
- name: Run PlatformIO
|
||||||
|
run: platformio run -e ${{ matrix.variant }}
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./build_output
|
||||||
|
|
||||||
|
language-images:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
variant: [ tasmota ]
|
||||||
|
language: [ AF, BG, BR, CN, CZ, DE, ES, FR, FY, GR, HE, HU, IT, KO, NL, PL, PT, RO, RU, SE, SK, TR, TW, UK, VN ]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v1
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
#python -m pip install --upgrade pip
|
||||||
|
pip install -U platformio
|
||||||
|
#platformio upgrade --dev
|
||||||
|
#platformio update
|
||||||
|
- name: Run PlatformIO
|
||||||
|
run: platformio run -e ${{ matrix.variant }}-${{ matrix.language }}
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./build_output
|
162
.github/workflows/build_devel.txt
vendored
Normal file
162
.github/workflows/build_devel.txt
vendored
Normal file
@ -0,0 +1,162 @@
|
|||||||
|
name: Build_development
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch: # Manually start a workflow
|
||||||
|
push:
|
||||||
|
branches: development
|
||||||
|
paths-ignore:
|
||||||
|
- '.github/**' # Ignore changes towards the .github directory
|
||||||
|
- '**.md' # Do no build if *.md files changes
|
||||||
|
|
||||||
|
# Ensures that only one deploy task per branch/environment will run at a time.
|
||||||
|
concurrency:
|
||||||
|
group: environment-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
base-images:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
continue-on-error: true
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
variant:
|
||||||
|
- tasmota
|
||||||
|
- tasmota4M
|
||||||
|
- tasmota-minimal
|
||||||
|
- tasmota-display
|
||||||
|
- tasmota-ir
|
||||||
|
- tasmota-knx
|
||||||
|
- tasmota-lite
|
||||||
|
- tasmota-sensors
|
||||||
|
- tasmota-zbbridge
|
||||||
|
- tasmota-zigbee
|
||||||
|
- tasmota32
|
||||||
|
- tasmota32-webcam
|
||||||
|
- tasmota32-bluetooth
|
||||||
|
- tasmota32-display
|
||||||
|
- tasmota32-ir
|
||||||
|
- tasmota32-lvgl
|
||||||
|
- tasmota32c3
|
||||||
|
- tasmota32c3usb
|
||||||
|
- tasmota32solo1
|
||||||
|
- tasmota32solo1-safeboot
|
||||||
|
- tasmota32-safeboot
|
||||||
|
- tasmota32c3-safeboot
|
||||||
|
- tasmota32c3usb-safeboot
|
||||||
|
- tasmota32s2-safeboot
|
||||||
|
- tasmota32s3-safeboot
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
ref: development
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -U platformio
|
||||||
|
- name: Run PlatformIO
|
||||||
|
run: platformio run -e ${{ matrix.variant }}
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./build_output
|
||||||
|
|
||||||
|
language-images:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
continue-on-error: true
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
variant: [ tasmota, tasmota32 ]
|
||||||
|
language: [ AF, BG, BR, CN, CZ, DE, ES, FR, FY, GR, HE, HU, IT, KO, NL, PL, PT, RO, RU, SE, SK, TR, TW, UK, VN ]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
ref: development
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -U platformio
|
||||||
|
- name: Run PlatformIO
|
||||||
|
run: platformio run -e ${{ matrix.variant }}-${{ matrix.language }}
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./build_output
|
||||||
|
|
||||||
|
Upload:
|
||||||
|
needs: [base-images, language-images]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
steps:
|
||||||
|
- uses: actions/download-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./mv_firmware
|
||||||
|
- name: Display structure of downloaded files
|
||||||
|
run: ls -R
|
||||||
|
working-directory: ./mv_firmware
|
||||||
|
- name: Move firmware files in sub-folders
|
||||||
|
run: |
|
||||||
|
mkdir -p ./firmware/tasmota/languages
|
||||||
|
mkdir -p ./firmware/tasmota32/languages
|
||||||
|
mkdir -p ./firmware/map
|
||||||
|
[ ! -f ./mv_firmware/map/* ] || mv ./mv_firmware/map/* ./firmware/map/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota.* ] || mv ./mv_firmware/firmware/tasmota.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota4M.* ] || mv ./mv_firmware/firmware/tasmota4M.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-sensors.* ] || mv ./mv_firmware/firmware/tasmota-sensors.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-minimal.bin.gz ] || mv ./mv_firmware/firmware/tasmota-minimal.bin.gz ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-lite.* ] || mv ./mv_firmware/firmware/tasmota-lite.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-ir*.* ] || mv ./mv_firmware/firmware/tasmota-ir*.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-display.* ] || mv ./mv_firmware/firmware/tasmota-display.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-knx.* ] || mv ./mv_firmware/firmware/tasmota-knx.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-zbbridge.* ] || mv ./mv_firmware/firmware/tasmota-zbbridge.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-zigbee.* ] || mv ./mv_firmware/firmware/tasmota-zigbee.* ./firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32.* ] || mv ./mv_firmware/firmware/tasmota32.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32solo1*.* ] || mv ./mv_firmware/firmware/tasmota32solo1*.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-ir*.* ] || mv ./mv_firmware/firmware/tasmota32-ir*.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-display.* ] || mv ./mv_firmware/firmware/tasmota32-display.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-lvgl.* ] || mv ./mv_firmware/firmware/tasmota32-lvgl.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-web*.* ] || mv ./mv_firmware/firmware/tasmota32-web*.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-odroidgo.* ] || mv ./mv_firmware/firmware/tasmota32-odroidgo.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-core2.* ] || mv ./mv_firmware/firmware/tasmota32-core2.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-bluetooth.* ] || mv ./mv_firmware/firmware/tasmota32-bluetooth.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32c3*.* ] || mv ./mv_firmware/firmware/tasmota32c3*.* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-safeboot* ] || mv ./mv_firmware/firmware/tasmota32-safeboot* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-* ] || mv ./mv_firmware/firmware/tasmota32-* ./firmware/tasmota32/languages/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32* ] || mv ./mv_firmware/firmware/tasmota32* ./firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/* ] || mv ./mv_firmware/firmware/* ./firmware/tasmota/languages/
|
||||||
|
- name: Display files to transfer
|
||||||
|
run: ls -R ./*
|
||||||
|
- name: Push Firmware files to tmp_copy repo
|
||||||
|
uses: Jason2866/copy_file_to_another_repo_action@main
|
||||||
|
env:
|
||||||
|
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
||||||
|
with:
|
||||||
|
source_file: 'firmware'
|
||||||
|
destination_repo: 'arendst/tmp_copy'
|
||||||
|
destination_branch: 'firmware'
|
||||||
|
user_email: 'github-actions@github.com'
|
||||||
|
user_name: 'github-actions'
|
||||||
|
|
||||||
|
Start_final_copy:
|
||||||
|
needs: Upload
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Creat trigger.txt
|
||||||
|
run: |
|
||||||
|
echo ${GITHUB_SHA} &> trigger.txt
|
||||||
|
echo "$(<trigger.txt)"
|
||||||
|
- name: Push trigger.txt to start workflow copy in tmp repo
|
||||||
|
uses: Jason2866/copy_file_to_another_repo_action@main
|
||||||
|
env:
|
||||||
|
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
||||||
|
with:
|
||||||
|
source_file: 'trigger.txt'
|
||||||
|
destination_repo: 'arendst/tmp_copy'
|
||||||
|
destination_branch: 'action-development'
|
||||||
|
user_email: 'github-actions@github.com'
|
||||||
|
user_name: 'github-actions'
|
170
.github/workflows/build_master.txt
vendored
Normal file
170
.github/workflows/build_master.txt
vendored
Normal file
@ -0,0 +1,170 @@
|
|||||||
|
name: Build_firmware_master
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: master
|
||||||
|
paths-ignore:
|
||||||
|
- '.github/**' # Ignore changes towards the .github directory
|
||||||
|
- '**.md' # Do no build if *.md files changes
|
||||||
|
|
||||||
|
# Ensures that only one deploy task per branch/environment will run at a time.
|
||||||
|
concurrency:
|
||||||
|
group: environment-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
base-images:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
continue-on-error: true
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
variant:
|
||||||
|
- tasmota
|
||||||
|
- tasmota4M
|
||||||
|
- tasmota-minimal
|
||||||
|
- tasmota-display
|
||||||
|
- tasmota-ir
|
||||||
|
- tasmota-knx
|
||||||
|
- tasmota-lite
|
||||||
|
- tasmota-sensors
|
||||||
|
- tasmota-zbbridge
|
||||||
|
- tasmota-zigbee
|
||||||
|
- tasmota32
|
||||||
|
- tasmota32-webcam
|
||||||
|
- tasmota32-bluetooth
|
||||||
|
- tasmota32-display
|
||||||
|
- tasmota32-ir
|
||||||
|
- tasmota32-lvgl
|
||||||
|
- tasmota32c3
|
||||||
|
- tasmota32c3usb
|
||||||
|
- tasmota32solo1
|
||||||
|
- tasmota32solo1-safeboot
|
||||||
|
- tasmota32-safeboot
|
||||||
|
- tasmota32c3-safeboot
|
||||||
|
- tasmota32s2-safeboot
|
||||||
|
- tasmota32s3-safeboot
|
||||||
|
- tasmota32c3usb-safeboot
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
ref: master
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -U platformio
|
||||||
|
- name: Run PlatformIO
|
||||||
|
run: platformio run -e ${{ matrix.variant }}
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./build_output
|
||||||
|
|
||||||
|
language-images:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
continue-on-error: true
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
variant: [ tasmota, tasmota32 ]
|
||||||
|
language: [ AF, BG, BR, CN, CZ, DE, ES, FR, FY, GR, HE, HU, IT, KO, NL, PL, PT, RO, RU, SE, SK, TR, TW, UK, VN ]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
ref: master
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -U platformio
|
||||||
|
- name: Run PlatformIO
|
||||||
|
run: platformio run -e ${{ matrix.variant }}-${{ matrix.language }}
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./build_output
|
||||||
|
|
||||||
|
Upload:
|
||||||
|
needs: [base-images, language-images]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- uses: actions/download-artifact@v2
|
||||||
|
with:
|
||||||
|
name: firmware
|
||||||
|
path: ./mv_firmware
|
||||||
|
- name: Display structure of downloaded files
|
||||||
|
run: ls -R ./mv_firmware/
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v1
|
||||||
|
#if: startsWith(github.ref, 'refs/tags/')
|
||||||
|
with:
|
||||||
|
tag_name: ${{ github.run_number }}
|
||||||
|
files: ./mv_firmware/firmware/*
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Move firmware files in sub-folders
|
||||||
|
run: |
|
||||||
|
mkdir -p ./release-firmware/tasmota/languages
|
||||||
|
mkdir -p ./release-firmware/tasmota32/languages
|
||||||
|
mkdir -p ./release-firmware/map
|
||||||
|
[ ! -f ./mv_firmware/map/* ] || mv ./mv_firmware/map/* ./release-firmware/map/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota.* ] || mv ./mv_firmware/firmware/tasmota.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota4M.* ] || mv ./mv_firmware/firmware/tasmota4M.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-sensors.* ] || mv ./mv_firmware/firmware/tasmota-sensors.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-minimal.bin.gz ] || mv ./mv_firmware/firmware/tasmota-minimal.bin.gz ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-lite.* ] || mv ./mv_firmware/firmware/tasmota-lite.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-ir*.* ] || mv ./mv_firmware/firmware/tasmota-ir*.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-display.* ] || mv ./mv_firmware/firmware/tasmota-display.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-knx.* ] || mv ./mv_firmware/firmware/tasmota-knx.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-zbbridge.* ] || mv ./mv_firmware/firmware/tasmota-zbbridge.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota-zigbee.* ] || mv ./mv_firmware/firmware/tasmota-zigbee.* ./release-firmware/tasmota/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32.* ] || mv ./mv_firmware/firmware/tasmota32.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32solo1*.* ] || mv ./mv_firmware/firmware/tasmota32solo1*.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-ir*.* ] || mv ./mv_firmware/firmware/tasmota32-ir*.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-display.* ] || mv ./mv_firmware/firmware/tasmota32-display.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-lvgl.* ] || mv ./mv_firmware/firmware/tasmota32-lvgl.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-web*.* ] || mv ./mv_firmware/firmware/tasmota32-web*.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-odroidgo.* ] || mv ./mv_firmware/firmware/tasmota32-odroidgo.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-core2.* ] || mv ./mv_firmware/firmware/tasmota32-core2.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-bluetooth.* ] || mv ./mv_firmware/firmware/tasmota32-bluetooth.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32c3*.* ] || mv ./mv_firmware/firmware/tasmota32c3*.* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-safeboot* ] || mv ./mv_firmware/firmware/tasmota32-safeboot* ./release-firmware/tasmota32/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32-* ] || mv ./mv_firmware/firmware/tasmota32-* ./release-firmware/tasmota32/languages/
|
||||||
|
[ ! -f ./mv_firmware/firmware/tasmota32* ] || mv ./mv_firmware/firmware/tasmota32* ./release-firmware/tasmota32/languages/
|
||||||
|
[ ! -f ./mv_firmware/firmware/* ] || mv ./mv_firmware/firmware/* ./release-firmware/tasmota/languages/
|
||||||
|
- name: Display files to transfer
|
||||||
|
run: ls -R ./*
|
||||||
|
- name: Push Firmware files to tmp_copy repo
|
||||||
|
uses: Jason2866/copy_file_to_another_repo_action@main
|
||||||
|
env:
|
||||||
|
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
||||||
|
with:
|
||||||
|
source_file: 'release-firmware'
|
||||||
|
destination_repo: 'arendst/tmp_copy'
|
||||||
|
destination_branch: 'firmware'
|
||||||
|
user_email: 'github-actions@github.com'
|
||||||
|
user_name: 'github-actions'
|
||||||
|
|
||||||
|
Start_final_copy:
|
||||||
|
needs: Upload
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Creat trigger.txt
|
||||||
|
run: |
|
||||||
|
echo ${GITHUB_SHA} &> trigger.txt
|
||||||
|
echo "$(<trigger.txt)"
|
||||||
|
- name: Push trigger.txt to start workflow copy in tmp repo
|
||||||
|
uses: Jason2866/copy_file_to_another_repo_action@main
|
||||||
|
env:
|
||||||
|
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
||||||
|
with:
|
||||||
|
source_file: 'trigger.txt'
|
||||||
|
destination_repo: 'arendst/tmp_copy'
|
||||||
|
destination_branch: 'action-master'
|
||||||
|
user_email: 'github-actions@github.com'
|
||||||
|
user_name: 'github-actions'
|
41
.github/workflows/copy_change.txt
vendored
Normal file
41
.github/workflows/copy_change.txt
vendored
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
name: Copy to docs repo
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch: # Manually start a workflow
|
||||||
|
push:
|
||||||
|
branches: development
|
||||||
|
paths:
|
||||||
|
- 'BUILDS.md'
|
||||||
|
- 'I2CDEVICES.md'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
|
||||||
|
copy_change:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository == 'arendst/Tasmota'
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Push I2CDevices.md to https://github.com/Tasmota/docs
|
||||||
|
uses: Jason2866/copy_file_to_another_repo_action@main
|
||||||
|
env:
|
||||||
|
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
||||||
|
with:
|
||||||
|
source_file: 'I2CDEVICES.md'
|
||||||
|
destination_repo: 'Tasmota/docs'
|
||||||
|
destination_branch: 'development'
|
||||||
|
destination_folder: 'docs'
|
||||||
|
user_email: 'github-actions@github.com'
|
||||||
|
user_name: 'github-actions'
|
||||||
|
commit_message: 'I2CDevices.md changed'
|
||||||
|
- name: Push Builds.md to https://github.com/Tasmota/docs
|
||||||
|
uses: Jason2866/copy_file_to_another_repo_action@main
|
||||||
|
env:
|
||||||
|
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
||||||
|
with:
|
||||||
|
source_file: 'BUILDS.md'
|
||||||
|
destination_repo: 'Tasmota/docs'
|
||||||
|
destination_branch: 'development'
|
||||||
|
destination_folder: 'docs'
|
||||||
|
user_email: 'github-actions@github.com'
|
||||||
|
user_name: 'github-actions'
|
||||||
|
commit_message: 'Builds.md changed'
|
21
.github/workflows/github-actions-change-variable.txt
vendored
Normal file
21
.github/workflows/github-actions-change-variable.txt
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# .github/workflows/github-actions-change-variable.yml
|
||||||
|
name: Variable Substitution
|
||||||
|
on:
|
||||||
|
# Triggers the workflow on push or pull request events but only for the main branch
|
||||||
|
push:
|
||||||
|
branches: [ docs ]
|
||||||
|
|
||||||
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: microsoft/variable-substitution@v1
|
||||||
|
with:
|
||||||
|
files: 'docs/_config.yml'
|
||||||
|
env:
|
||||||
|
recaptcha_site_key: "6LfKJsMfAAAAAFLjDTY0PG9RdcpLBuiuoFNyQLsh"
|
||||||
|
ga_tracking: "UA-5555555-55"
|
23
.github/workflows/github-actions-template.txt
vendored
Normal file
23
.github/workflows/github-actions-template.txt
vendored
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
name: GitHub Actions Demo
|
||||||
|
on:
|
||||||
|
# Triggers the workflow on push or pull request events but only for the main branch
|
||||||
|
push:
|
||||||
|
branches: [ docs ]
|
||||||
|
|
||||||
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
|
workflow_dispatch:
|
||||||
|
jobs:
|
||||||
|
Explore-GitHub-Actions:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||||
|
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||||
|
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
|
||||||
|
- name: Check out repository code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
|
||||||
|
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
|
||||||
|
- name: List files in the repository
|
||||||
|
run: |
|
||||||
|
ls ${{ github.workspace }}
|
||||||
|
- run: echo "🍏 This job's status is ${{ job.status }}."
|
23
.github/workflows/stale-actions.yml
vendored
Normal file
23
.github/workflows/stale-actions.yml
vendored
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
name: "Mark or close stale issues and PRs"
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "30 * * * *"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
stale:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/stale@v3.0.15
|
||||||
|
with:
|
||||||
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
days-before-stale: 25
|
||||||
|
days-before-close: 5
|
||||||
|
stale-issue-message: "This issue has been automatically marked as stale because it hasn't any activity in last few weeks. It will be closed if no further activity occurs. Thank you for your contributions."
|
||||||
|
stale-pr-message: "This PR has been automatically marked as stale because it hasn't any activity in last few weeks. It will be closed if no further activity occurs. Thank you for your contributions."
|
||||||
|
close-issue-message: "This issue was automatically closed because of being stale. Feel free to open a new one if you still experience this problem."
|
||||||
|
close-pr-message: "This PR was automatically closed because of being stale."
|
||||||
|
stale-pr-label: "stale"
|
||||||
|
stale-issue-label: "stale"
|
||||||
|
exempt-issue-labels: "bug,enhancement,pinned,security"
|
||||||
|
exempt-pr-labels: "bug,enhancement,pinned,security"
|
155
.github/workflows/write_file.txt
vendored
Normal file
155
.github/workflows/write_file.txt
vendored
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
name: Write File
|
||||||
|
on:
|
||||||
|
# Triggers the workflow on push or pull request events but only for the docs branch
|
||||||
|
push:
|
||||||
|
branches: [docs]
|
||||||
|
|
||||||
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
|
workflow_dispatch:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Git checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: '0'
|
||||||
|
- name: Declare status of job
|
||||||
|
run: |
|
||||||
|
echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||||
|
echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||||
|
echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
|
||||||
|
echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
|
||||||
|
echo "🖥️ The workflow is now ready to test your code on the runner."
|
||||||
|
- name: List files in the repository
|
||||||
|
run: |
|
||||||
|
ls ${{ github.workspace }}
|
||||||
|
- run: echo "🍏 This job's status is ${{ job.status }}."
|
||||||
|
- run: echo "✍ Writing to file."
|
||||||
|
- uses: DamianReeves/write-file-action@master
|
||||||
|
with:
|
||||||
|
path: ${{ github.workspace }}/docs/_config.yml
|
||||||
|
contents: |
|
||||||
|
title: 'EyeTrackVR Documentation'
|
||||||
|
description: 'Documentation for EyeTrackVR and related projects'
|
||||||
|
author: 'ZanzyTHEbar'
|
||||||
|
email: info@h-bat.com
|
||||||
|
# baseurl: "" # the subpath of your site, e.g. /blog
|
||||||
|
url: "https://redhawk989.github.io"
|
||||||
|
|
||||||
|
# twitter_username:
|
||||||
|
# facebook_username:
|
||||||
|
github_username: RedHawk989
|
||||||
|
|
||||||
|
# Build settings
|
||||||
|
remote_theme: just-the-docs/just-the-docs
|
||||||
|
color_scheme: light
|
||||||
|
search_enabled: true
|
||||||
|
heading_level: 6
|
||||||
|
previews: 3
|
||||||
|
|
||||||
|
permalink: pretty
|
||||||
|
exclude:
|
||||||
|
[
|
||||||
|
'node_modules/',
|
||||||
|
'*.gemspec',
|
||||||
|
'*.gem',
|
||||||
|
'gemfiles/',
|
||||||
|
'Gemfile',
|
||||||
|
'Gemfile.lock',
|
||||||
|
'package.json',
|
||||||
|
'package-lock.json',
|
||||||
|
'script/',
|
||||||
|
'LICENSE.txt',
|
||||||
|
'lib/',
|
||||||
|
'bin/',
|
||||||
|
'Rakefile',
|
||||||
|
'docs/tests/',
|
||||||
|
'.sass-cache/',
|
||||||
|
'.jekyll-cache/',
|
||||||
|
'node_modules/',
|
||||||
|
'vendor/bundle/',
|
||||||
|
'vendor/cache/',
|
||||||
|
'vendor/gems/',
|
||||||
|
'vendor/ruby/',
|
||||||
|
]
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- jekyll-feed
|
||||||
|
- jekyll-seo-tag
|
||||||
|
- jekyll-sitemap
|
||||||
|
- jekyll-mermaid
|
||||||
|
- jekyll-spaceship
|
||||||
|
|
||||||
|
include: ["_pages", "_posts"]
|
||||||
|
timezone: "America/New_York"
|
||||||
|
|
||||||
|
# Search options
|
||||||
|
preview_words_before: 5
|
||||||
|
preview_words_after: 10
|
||||||
|
tokenizer_separator: /[\s/]+/
|
||||||
|
rel_url: true
|
||||||
|
button: true
|
||||||
|
|
||||||
|
# Links at the top of the page
|
||||||
|
aux_links:
|
||||||
|
'Documentation':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR/tree/main/docs/Reference_Docs'
|
||||||
|
'Scripts':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR/tree/main/scripts'
|
||||||
|
'InceptionNet':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR/tree/main/InceptionNet'
|
||||||
|
'RANSAC':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR/tree/main/RANSAC'
|
||||||
|
'Issues':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR/issues'
|
||||||
|
'GitHub':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR'
|
||||||
|
'Wiki':
|
||||||
|
- '//github.com/RedHawk989/EyeTrackVR/wiki'
|
||||||
|
|
||||||
|
# Enable Back to Top bottom for all pages
|
||||||
|
back_to_top: true
|
||||||
|
back_to_top_text: "Top"
|
||||||
|
|
||||||
|
# Enable last edit timestamp for all pages
|
||||||
|
last_edit_timestamp: true
|
||||||
|
last_edit_time_format: "%b %e %Y at %I:%M %p"
|
||||||
|
|
||||||
|
# Sitemap options
|
||||||
|
aux_links_new_tab: false # Whether to open aux_links in a new tab
|
||||||
|
heading_anchors: true
|
||||||
|
gh_edit_link: true # show or hide edit this page link
|
||||||
|
gh_edit_link_text: 'Edit this page on GitHub.'
|
||||||
|
gh_edit_repository: 'https://github.com/RedHawk989/EyeTrackVR' # the github URL for your repo
|
||||||
|
gh_edit_branch: 'docs' # the branch that your docs is served from
|
||||||
|
gh_edit_source: docs # the source that your files originate from
|
||||||
|
gh_edit_view_mode: 'edit' # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||||
|
ga_tracking: UA-5555555-55 # Google Analytics tracking code - Dahl Winters please update this to your own code
|
||||||
|
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)
|
||||||
|
|
||||||
|
# Google Forms configuration
|
||||||
|
# comment-post: https://docs.google.com/forms/d/e/1FAIpQLScuqqkKDIUbPJpGfyLQJQe3mBNvQh45-eryzMWbqm7k7ALjGA
|
||||||
|
# comment-read: https://docs.google.com/spreadsheets/d/1szz__qSlPZ5LmDlR9ovNqdSCOgoUAYCWg-gWwkCQlmw/
|
||||||
|
# comment-post-fields: [entry.1141065141, entry.484163683, entry.231340692]
|
||||||
|
google_forms_comments:
|
||||||
|
google_app_script: https://script.google.com/macros/s/AKfycbyvN6BYATPrSahv5SpWKC44yu7GJmlVYyzl6HZeDlYZI5T6PJ5HuF2IMGvTO7E4cA34ng/exec
|
||||||
|
recaptcha_site_key: 6LcOgsQfAAAAAF1GB4ENB-qwe8vdtsqbHS1duIeV
|
||||||
|
chunked_comment_loading: true
|
||||||
|
lazy_load_comments: true
|
||||||
|
comment_replies_enabled: true
|
||||||
|
write-mode: overwrite
|
||||||
|
- name: git
|
||||||
|
run: |
|
||||||
|
# setup the username and email, use 'GitHub Actions Bot' with no email by default
|
||||||
|
git --version
|
||||||
|
git config user.name "GitHub Actions Bot"
|
||||||
|
git config user.email "<>"
|
||||||
|
git status
|
||||||
|
git tag
|
||||||
|
git add docs/_config.yml
|
||||||
|
git commit -m "file updated"
|
||||||
|
git push https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git HEAD
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- run: echo "✍ File written with status ${{ job.status }}."
|
128
CODE_OF_CONDUCT.md
Normal file
128
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating empathy and kindness toward other people
|
||||||
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
* Giving and gracefully accepting constructive feedback
|
||||||
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
[Contact Us](https://redhawk989.github.io/EyeTrackVR/contact/).
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||||
|
enforcement ladder](https://github.com/mozilla/diversity).
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
<https://www.contributor-covenant.org/faq>. Translations are available at
|
||||||
|
<https://www.contributor-covenant.org/translations>.
|
17
SECURITY.md
Normal file
17
SECURITY.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
This section will be used to tell people about which versions of our project are
|
||||||
|
currently being supported with security updates.
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
| ------- | ------------------ |
|
||||||
|
| 5.1.x | :white_check_mark: |
|
||||||
|
| 5.0.x | :x: |
|
||||||
|
| 4.0.x | :white_check_mark: |
|
||||||
|
| < 4.0 | :x: |
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
Please report security issues to <https://redhawk989.github.io/EyeTrackVR/contact/>
|
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
---
|
|
||||||
{% include css/just-the-docs.scss.liquid color_scheme="openair" %}
|
|
@ -1,3 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
|
|
||||||
jtd.setTheme("openair");
|
|
18
repo-tools/CODE_OWNERS.md
Normal file
18
repo-tools/CODE_OWNERS.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<!-- <img src="./img/logo.png" alt="Logo" align="right" height="76"/> -->
|
||||||
|
|
||||||
|
# Code Owners
|
||||||
|
|
||||||
|
In addition to @RedHawk989 the following code is mainly owned by:
|
||||||
|
|
||||||
|
| Code | Owner
|
||||||
|
|----------------------------|---------------------------
|
||||||
|
| EyeTrackVR Drivers |
|
||||||
|
| all | @RedHawk989
|
||||||
|
| |
|
||||||
|
| EyeTrackVR Source Code |
|
||||||
|
| all | @RedHawk989
|
||||||
|
| |
|
||||||
|
| RANSAC and Calibration |
|
||||||
|
| all | @SummerSigh
|
||||||
|
| |
|
||||||
|
| Github Pages | @ZanzyTHEbar
|
112
repo-tools/CONTRIBUTING.md
Normal file
112
repo-tools/CONTRIBUTING.md
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
<!-- <img src="./img/logo.png" alt="Logo" align="right" height="76"/> -->
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
**Any contribution helps our team and make EyeTrackVR better for the entire community!**
|
||||||
|
|
||||||
|
Everybody is welcome and invited to contribute to the EyeTrackVR Project by:
|
||||||
|
|
||||||
|
* Testing newly released features and reporting issues.
|
||||||
|
* Providing Pull Requests (Features, Proof of Concepts, Language files or Fixes)
|
||||||
|
* Contributing missing documentation for features and devices in our [documentation](https://redhawk989.github.io/EyeTrackVR/)
|
||||||
|
|
||||||
|
This document describes rules that are in effect for this repository, meant for handling issues by contributors in the issue tracker and PRs.
|
||||||
|
|
||||||
|
## Opening New Issues
|
||||||
|
|
||||||
|
**Issue tracker is NOT a general discussion forum!**
|
||||||
|
|
||||||
|
1. Opening an issue means that a problem exists in the code and should be addressed by the project contributors.
|
||||||
|
2. When opening an issue, it is required to fill out the presented template. The requested information is important! If the template is ignored or insufficient info about the issue is provided, the issue may be closed.
|
||||||
|
3. Questions of type "How do I..." or "Can you please help me with..." or "Can EyeTrackVR do..." WILL NOT be handled here. Such questions should be directed at a discussion forum or to the EyeTrackVR Support Chat. All issues of this type will be closed with a simple reference to this contributing policy.
|
||||||
|
4. Issues about topics already handled in the documentation will be closed in a similar manner.
|
||||||
|
5. Issues for unmerged PRs will be closed. If there is an issue with a PR, the explanation should be added to the PR itself.
|
||||||
|
6. Issues with accompanied investigation that shows the root of the problem should be given priority.
|
||||||
|
7. Duplicate issues will be closed.
|
||||||
|
|
||||||
|
## Triaging of Issues/PR's
|
||||||
|
|
||||||
|
1. Any contributor to the project can participate in the triaging process, if he/she chooses to do so.
|
||||||
|
2. An issue that needs to be closed, either due to not complying with this policy, or for other reasons, should be closed by a contributor.
|
||||||
|
3. Issues that are accepted should be marked with appropriate labels.
|
||||||
|
4. Issues that could impact functionality for many users should be considered severe.
|
||||||
|
5. Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in the Wiki, for reference by users.
|
||||||
|
6. Issues with feature requests should be discussed for viability/desirability.
|
||||||
|
7. Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified.
|
||||||
|
8. Feature requests that are not accompanied by a PR:
|
||||||
|
* could be closed immediately (denied).
|
||||||
|
* could be closed after some predetermined period of time (left as candidate for somebody to pick up).
|
||||||
|
9. In some cases, feedback may be requested from the issue reporter, either as additional info for clarification, additional testing, or other. If no feedback is provided, the issue may be closed by a contributor or after 30 days by the STALE bot.
|
||||||
|
|
||||||
|
## Pull requests
|
||||||
|
|
||||||
|
A Pull Request (PR) is the process where code modifications are managed in GitHub.
|
||||||
|
|
||||||
|
The process is straight-forward.
|
||||||
|
|
||||||
|
* Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0)
|
||||||
|
* Fork the EyeTrackVR Repository [git repository](https://github.com/RedHawk989/EyeTrackVR).
|
||||||
|
* Write/Change the code in your Fork for a new feature, bug fix, new sensor, optimization, etc.
|
||||||
|
* Ensure tests work.
|
||||||
|
* Create a Pull Request against the [**development**](https://github.com/RedHawk989/EyeTrackVR/tree/dev) branch of EyeTrackVR.
|
||||||
|
|
||||||
|
1. All pull requests must be done against the development branch.
|
||||||
|
2. Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
|
||||||
|
3. Only one feature/fix should be added per PR.
|
||||||
|
4. If adding a new functionality (new hardware, new library support) not related to an existing component move it to it's own modules (.ino file).
|
||||||
|
5. PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in development - you might need to rebase and resolve conflicts.
|
||||||
|
6. All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
|
||||||
|
7. All pull requests should consider updates to the documentation.
|
||||||
|
8. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
|
||||||
|
9. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
|
||||||
|
10. By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
|
||||||
|
11. Pull requests that don't meet the above will be denied and closed.
|
||||||
|
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
## Contributor License Agreement (CLA)
|
||||||
|
|
||||||
|
```txt
|
||||||
|
By making a contribution to this project, I certify that:
|
||||||
|
|
||||||
|
(a) The contribution was created in whole or in part by me and I
|
||||||
|
have the right to submit it under the GPL-3.0 license; or
|
||||||
|
|
||||||
|
(b) The contribution is based upon previous work that, to the best
|
||||||
|
of my knowledge, is covered under an appropriate open source
|
||||||
|
license and I have the right under that license to submit that
|
||||||
|
work with modifications, whether created in whole or in part
|
||||||
|
by me, under the GPL-3.0 license; or
|
||||||
|
|
||||||
|
(c) The contribution was provided directly to me by some other
|
||||||
|
person who certified (a), (b) or (c) and I have not modified
|
||||||
|
it.
|
||||||
|
|
||||||
|
(d) I understand and agree that this project and the contribution
|
||||||
|
are public and that a record of the contribution (including all
|
||||||
|
personal information I submit with it) is maintained indefinitely
|
||||||
|
and may be redistributed consistent with this project or the open
|
||||||
|
source license(s) involved.
|
||||||
|
```
|
||||||
|
|
||||||
|
This Contributor License Agreement (CLA) was adopted on April 1st, 2019.
|
||||||
|
|
||||||
|
The text of this license is available under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/). It is based on the Linux [Developer Certificate Of Origin](http://elinux.org/Developer_Certificate_Of_Origin), but is modified to explicitly use the GPL-3.0 license and not mention sign-off (due to GitHub.com keeps an historical, with your user name, of PRs' commits and all editions on PR's comments).
|
||||||
|
|
||||||
|
To accept the CLA it is required to put a x between [ ] on `[ ] I accept the CLA` in the PR template when submitting it. The [ ] is an opt-in box, so you have to manually accept it.
|
||||||
|
|
||||||
|
**Why a CLA ?**
|
||||||
|
|
||||||
|
_"A Contributor Licence Agreement (CLA) is strongly recommended when accepting third party contributions to an open development project, such as an open source software project. In order to redistribute contributions, it is necessary to ensure that the project has the necessary rights to do so. A Contributor Licence Agreement is a lightweight agreement, signed by the copyright holder, that grants the necessary rights for the contribution to be redistributed as part of the project."_ [OSS Watch](http://oss-watch.ac.uk/resources/cla)
|
||||||
|
|
||||||
|
A CLA is a legal document in which you state _you are entitled to contribute the code/documentation/translation to the project_ you’re contributing to and that _you are willing to have it used in distributions and derivative works_. This means that should there be any kind of legal issue in the future as to the origins and ownership of any particular piece of code, then that project has the necessary forms on file from the contributor(s) saying they were permitted to make this contribution.
|
||||||
|
|
||||||
|
CLA is a safety because it also ensures that once you have provided a contribution, you cannot try to withdraw permission for its use at a later date. People can therefore use that software, confident that they will not be asked to stop using pieces of the code at a later date.
|
||||||
|
|
||||||
|
A **license** grants "outbound" rights to the user of project.
|
||||||
|
|
||||||
|
A **CLA** enables a contributor to grant "inbound" rights to a project.
|
||||||
|
|
||||||
|
<Other>
|
||||||
|
<A table should be maintained for relating maintainers and components. When triaging, this is essential to figure out if someone in particular should be consulted about specific changes.>
|
||||||
|
<A stable release cadence should be established, e.g.: every month.>
|
2489
repo-tools/Doxyfile
Normal file
2489
repo-tools/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
66
repo-tools/todo.yml
Normal file
66
repo-tools/todo.yml
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
---
|
||||||
|
TO_DO:
|
||||||
|
STATE: ['TO_DO' = [], 'IN_PROGRESS' = [-],'DONE' = [x]]
|
||||||
|
Description: This is a list of things that need to be done.
|
||||||
|
Tasks:
|
||||||
|
|
||||||
|
--------- HIGH PRIORITY ---------
|
||||||
|
|
||||||
|
- [] hardware guide (parts list and wiring diagram)
|
||||||
|
|
||||||
|
- [] avatar set up guide
|
||||||
|
|
||||||
|
- [] flashing firmware guide
|
||||||
|
|
||||||
|
- [] camera placement guide with correct and incorrect examples etc
|
||||||
|
|
||||||
|
- [] project aspirations and limits
|
||||||
|
|
||||||
|
- [] expanded FAQ.
|
||||||
|
|
||||||
|
- [] expanded project description
|
||||||
|
|
||||||
|
- [] Re-vamp the wiki
|
||||||
|
|
||||||
|
-------- LOW PRIORITY --------
|
||||||
|
|
||||||
|
- [] any working 3d printed mounts or solutions for other headsets
|
||||||
|
|
||||||
|
-------- Baseline Tasks --------
|
||||||
|
|
||||||
|
- [] Add everything to Github Pages - Add
|
||||||
|
|
||||||
|
- [] Optimize the code - Optimize
|
||||||
|
|
||||||
|
- [] Fix the bugs - Fix
|
||||||
|
|
||||||
|
- [] Add new features - Add
|
||||||
|
|
||||||
|
- [] Test the code - Test
|
||||||
|
|
||||||
|
- [] Document the code - Document
|
||||||
|
|
||||||
|
TO_DO_ITEMS:
|
||||||
|
Done: false
|
||||||
|
Due: Null
|
||||||
|
Priority:
|
||||||
|
Tags:
|
||||||
|
- In_Progress
|
||||||
|
- Optimize
|
||||||
|
- Formatting
|
||||||
|
- Efficiency
|
||||||
|
- Scanning
|
||||||
|
- Hashing
|
||||||
|
- Reboot
|
||||||
|
- Connecting
|
||||||
|
- Done
|
||||||
|
Contexts:
|
||||||
|
Projects:
|
||||||
|
Notes:
|
||||||
|
Links: []
|
||||||
|
Creator:
|
||||||
|
Name: ZanzyTHEbar
|
||||||
|
Website: https://github.com/ZanzyTHEbar
|
||||||
|
Company: Prometheon Technologies Bv
|
||||||
|
Position: Documentation Manager
|
||||||
|
Notes: Awesome dev wizard
|
Loading…
Reference in New Issue
Block a user