added more files
This commit is contained in:
33
.github/copilot-instructions.md
vendored
Normal file
33
.github/copilot-instructions.md
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
applyTo: "**"
|
||||
---
|
||||
## Project general
|
||||
- Digital Read Out for a lathe
|
||||
- Uses 2 rotary encoders to keep track of lathe tool location
|
||||
- Code base is a mix of C++ Arduino code and python
|
||||
- The main python application is deployed on Raspberry Pi
|
||||
- Architectural pattern, the main application uses MVC
|
||||
- the main application reads rotary encoder location from Arduino via i2c
|
||||
- Documentation standards: Use clear and concise language, include code examples where applicable, and maintain consistent formatting throughout the documentation.
|
||||
- Try to follow the DRY and KISS principles
|
||||
|
||||
## Project structure
|
||||
|
||||
- i2c_encoder/ : arduino application for reading encoder position and transitting via i2c
|
||||
RPi/ : fake python module for testing on PC
|
||||
|
||||
## Tech stack in use
|
||||
|
||||
- Raspberry Pi 4
|
||||
- Tkinter front-end
|
||||
- Arduino Nano
|
||||
|
||||
## Custom instructions
|
||||
|
||||
| Instruction | Description |
|
||||
|-------------|-------------|
|
||||
|[Code review](./instructions/code-review-generic.instructions.md) | Generic code review instructions that can be customized for any project using GitHub Copilot |
|
||||
|[C++](./instructions/cpp.instructions.md) | Language specific instructions for C++ |
|
||||
| [Python](./instructions/python.instructions.md) | Language specific instructions for Python |
|
||||
| [Documentation](./instructions/documentation.instructions.md) | Generall instructions when writing documentation |
|
||||
| [Shell](./instructions/shell.instructions.md) | Generall instructions when writing shell scripts |
|
||||
Reference in New Issue
Block a user