Barn Quilt

Table of Contents

1. Project Status
2. Getting Started
   1. Dependencies
   2. Building
   3. Running Tests
      1. Other Tests
   4. Installation
   5. Usage
3. Release Process
   1. Versioning
   2. Payload
4. How to Get Help
5. Contributing
6. Further Reading
7. License
8. Authors
9. Acknowledgments

Back to top

Project Status

Current work

• Prototype web page controller
• Arduino code for controlling LEDs

Up Next

• Move Arduino code to espidf and add captive web portal, preparing to connect web controller

Back to top

Getting Started

TBD: This section should provide instructions for other developers to work on the project

Dependencies

p5.js library

Copy of p5.min.js (renamed to p5.js) acquired on 2021-12-28 included in repo to be installed on and served from device.

Getting the Source

This project is hosted on GitHub. You can clone this project directly using this command:

git clone [email protected]:baileysage/barn-quilt.git

Building

TBD: Instructions for how to build your project

Examples should be included

Running Tests

TBD: Describe how to run unit tests for your project.

Examples should be included

Other Tests

TBD: If you have formatting checks, coding style checks, or static analysis tests that must pass before changes will be considered, add a section for those and provide instructions

Installation

TBD: Instructions for how to install your project's build artifacts

Examples should be included

Usage

TBD: Instructions for using your project. Ways to run the program, how to include it in another project, etc.

Examples should be included

Back to top

Release Process

TBD: Talk about the release process. How are releases made? What cadence? How to get new releases?

Versioning

This project uses Semantic Versioning. For a list of available versions, see the repository tag list.

Payload

TBD

Back to top

Further Reading

TBD: Provide links to other relevant documentation here

Back to top

License

Copyright (c) 2022 Stone Path Engineering LLC

This project is licensed under the MIT License - see LICENSE file for details.

Back to top

Authors

• Bailey Sage - Initial work - Stone Path Engineering

Also see the list of contributors who participated in this project.

Back to top

Acknowledgments

README template from Embedded Artistry

Back to top