mirror of
https://github.com/Wessel/PICAMP.git
synced 2026-06-08 22:18:09 +02:00
fix: Accurate naming
This commit is contained in:
17
.github/CONTRIBUTING.md
vendored
17
.github/CONTRIBUTING.md
vendored
@@ -6,7 +6,7 @@ Used linters:
|
|||||||
[EditorConfig](https://editorconfig.org)
|
[EditorConfig](https://editorconfig.org)
|
||||||
--->
|
--->
|
||||||
|
|
||||||
If you wish to contribute to PICDAC, feel free to fork the repository and submit a pull request.
|
If you wish to contribute to PICAMP, feel free to fork the repository and submit a pull request.
|
||||||
editorconfig is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
|
editorconfig is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
|
||||||
so it would be much appreciated if you installed editorconfig to your editor of choice
|
so it would be much appreciated if you installed editorconfig to your editor of choice
|
||||||
|
|
||||||
@@ -19,29 +19,18 @@ Prerequisites for Node.JS:
|
|||||||
* [(OPTIONAL) Yarn](https://yarnpkg.com)
|
* [(OPTIONAL) Yarn](https://yarnpkg.com)
|
||||||
--->
|
--->
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
The following prerequisites must be met before installing PICDAC:
|
The following prerequisites must be met before installing PICAMP:
|
||||||
- [XC8 v2.45](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers)
|
- [XC8 v2.45](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers)
|
||||||
- [MPLAB X IDE/IPE](https://www.microchip.com/en-us/tools-resources/develop/mplab-x-ide)
|
- [MPLAB X IDE/IPE](https://www.microchip.com/en-us/tools-resources/develop/mplab-x-ide)
|
||||||
- [MPLAB PICKit In-Circuit Debugger](https://www.microchip.com/en-us/development-tool/pg164150)
|
- [MPLAB PICKit In-Circuit Debugger](https://www.microchip.com/en-us/development-tool/pg164150)
|
||||||
|
|
||||||
<!---
|
|
||||||
Install commands:
|
|
||||||
JavaScript/TypeScript: `yarn --dev` or `npm install --dev`
|
|
||||||
Rust: `cargo run`
|
|
||||||
C: `make clean install`
|
|
||||||
|
|
||||||
Run commands:
|
|
||||||
JavaScript/TypeScript: `yarn test` or `npm run test`
|
|
||||||
Rust: `cargo run`
|
|
||||||
C: `make clean dev`
|
|
||||||
--->
|
|
||||||
## Setup
|
## Setup
|
||||||
To get ready to work on the codebase, please do the following:
|
To get ready to work on the codebase, please do the following:
|
||||||
|
|
||||||
1. Fork & clone the repository, and make sure you are on the **master** branch
|
1. Fork & clone the repository, and make sure you are on the **master** branch
|
||||||
2. Open the project in MPLAB X
|
2. Open the project in MPLAB X
|
||||||
3. Code your ideas and test them using the PICKit
|
3. Code your ideas and test them using the PICKit
|
||||||
4. [Submit a pull request](https://github.com/wessel/PICDAC/compare)
|
4. [Submit a pull request](https://github.com/wessel/PICAMP/compare)
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
When creating any new functions, please also create unit tests for them in the `tests` directory.
|
When creating any new functions, please also create unit tests for them in the `tests` directory.
|
||||||
|
|||||||
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: Pull Request
|
name: Pull Request
|
||||||
about: Propose changes to PICDAC
|
about: Propose changes to PICAMP
|
||||||
title: "[PR] Your changes"
|
title: "[PR] Your changes"
|
||||||
labels: pullrequest
|
labels: pullrequest
|
||||||
assignees: Wessel
|
assignees: Wessel
|
||||||
@@ -14,6 +14,6 @@ assignees: Wessel
|
|||||||
- [ ] Code changes have been tested and there aren't any typos in it
|
- [ ] Code changes have been tested and there aren't any typos in it
|
||||||
|
|
||||||
**Semantic versioning classification:**
|
**Semantic versioning classification:**
|
||||||
- [ ] This PR changes PICDAC core codebase (methods or parameters added)
|
- [ ] This PR changes PICAMP core codebase (methods or parameters added)
|
||||||
- [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
|
- [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
|
||||||
- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.
|
- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.
|
||||||
|
|||||||
@@ -7,11 +7,11 @@ To update:
|
|||||||
<img src="assets/msdac.jpg" align="left" width="192px" height="192px"/>
|
<img src="assets/msdac.jpg" align="left" width="192px" height="192px"/>
|
||||||
<img align="left" width="0" height="192px" hspace="10"/>
|
<img align="left" width="0" height="192px" hspace="10"/>
|
||||||
|
|
||||||
> PICDAC
|
> PICAMP
|
||||||
|
|
||||||
[](/LICENSE) [](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers)
|
[](/LICENSE) [](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers)
|
||||||
|
|
||||||
PICDAC is an audio amplifier interface built using the PIC16F887A microcontroller.
|
PICAMP is an audio amplifier interface built using the PIC16F887A microcontroller.
|
||||||
|
|
||||||
<br><br>
|
<br><br>
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
<type>com.microchip.mplab.nbide.embedded.makeproject</type>
|
<type>com.microchip.mplab.nbide.embedded.makeproject</type>
|
||||||
<configuration>
|
<configuration>
|
||||||
<data xmlns="http://www.netbeans.org/ns/make-project/1">
|
<data xmlns="http://www.netbeans.org/ns/make-project/1">
|
||||||
<name>PICDAC</name>
|
<name>PICAMP</name>
|
||||||
<creation-uuid>6e82f017-1e11-4f32-aea4-27829d036f6c</creation-uuid>
|
<creation-uuid>6e82f017-1e11-4f32-aea4-27829d036f6c</creation-uuid>
|
||||||
<make-project-type>0</make-project-type>
|
<make-project-type>0</make-project-type>
|
||||||
<sourceEncoding>ISO-8859-1</sourceEncoding>
|
<sourceEncoding>ISO-8859-1</sourceEncoding>
|
||||||
|
|||||||
Reference in New Issue
Block a user