Skip to content
This repository has been archived by the owner on Aug 23, 2024. It is now read-only.

Commit

Permalink
Merge pull request #71 from Pwnagotchi-Unofficial/development
Browse files Browse the repository at this point in the history
markdown consistency
  • Loading branch information
dj1ch authored Feb 7, 2024
2 parents 996d58e + 66d3ea7 commit 5b9fb41
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
18 changes: 13 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Minigotchi contributing guidelines

Hello everyone, whether you be from hacktoberfest or just some random person who stumbled upon this repository. Be sure to follow our contributing guidelines! This project needs just as much help from the community as it does from the maintainer itself.

#
## How can I contribute?
### How can I contribute?

**Remember if you have write access to this, please do not make any changes to the main branch unless it is 100% necessary! Push commits to the [development](https://github.com/Pwnagotchi-Unofficial/minigotchi/tree/development) branch instead and make a [pull request](https://github.com/Pwnagotchi-Unofficial/minigotchi/pulls)!**

1. Fork and clone the repository

`git clone https://github.com/<your username>/minigotchi.git`
Expand Down Expand Up @@ -29,16 +34,19 @@ I recommend getting the hardware needed and making sure this works. Test using t
6. Open a pull request

Go to your forked repository on GitHub, switch to the branch you just pushed, and click on the "New Pull Request" button. Fill out the necessary information and submit the pull request.
##
## More ways to contribute to development

###
### More ways to contribute to development

Don't worry if you can't code! There's other ways to help!

1. You can give this project money through this [Open Source Collective](https://opencollective.com/minigotchi). It's not a lot of money but it does help the me, the main developer.

2. You can also suggest features by communicating with me, see *Communication* section of the [README.md](README.md). Or, you can make an issue and suggest a feature to me.
2. You can also suggest features by communicating with me, see *Communication* section of the [wiki](https://github.com/Pwnagotchi-Unofficial/minigotchi/wiki/Communication). Or, you can make an issue and suggest a feature to me.

##
###
# Code structure

Most of the code is object oriented. I essentially grouped all of the main functions into their own .cpp and .h files, then inclded those files in the main .ino file. I am trying to make this as easy to maintain as possible. It's easier on me and others if each part was seperated and organized. Here's some more info on the [OOP(Object oriented programming)](https://en.wikipedia.org/wiki/Object-oriented_programming).

#
3 changes: 2 additions & 1 deletion FACES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Faces

The minigotchi has multiple faces, similar to that of the pwnagotchi. I tried my best here to adhere to how emotions were handled with the pwnagotchi. It doesn't exactly have an emotion set using a setting, rather having the emotion being shown to the user. It might be best to have the emotion set to a variable, although this will be done later.

**Note that these are the only emotions that the minigotchi is capable of showing. You may add your own but at this moment the last release doesn't have any emotions.**
Expand Down Expand Up @@ -28,4 +29,4 @@ The minigotchi has multiple faces, similar to that of the pwnagotchi. I tried my
- may have something to say

### (-.-) Sleeping
- switching channel
- switching channel
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Install guide
Here you can find out how to install minigotchi on the esp8266, or the raspberry pi pico. The esp8266 microcontroller has more support than the pico at the moment. They can be both built using arduino, ~~but you can build manually with the pico, assuming that you have all the libraries from the arduino esp8266 repo. Again, building with Arduino IDE is an option for the raspberry pi pico.~~ The support for this has been dropped, as this is not maintained nor tested by me.
Here you can find out how to install minigotchi on the ESP8266, or the raspberry pi pico. The ESP8266 microcontroller has more support than the pico at the moment. They can be both built using arduino, ~~but you can build manually with the pico, assuming that you have all the libraries from the arduino ESP8266 repo. Again, building with Arduino IDE is an option for the raspberry pi pico.~~ The support for this has been dropped, as this is not maintained nor tested by me.
#### Building using Arduino IDE/Web editor
I believe that you can also use the raspberry pi pico and run arduino .ino files. It would be much easier to do this then to build it yourself manually.
- Download the latest release [here](https://github.com/Pwnagotchi-Unofficial/minigotchi/releases).
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Although nothing will be coded in these langauges(most likely) on this project,
- Patience (a lot of it)
### How it operates/works

See the [wiki](https://github.com/Pwnagotchi-Unofficial/minigotchi/wiki/How-the-Minigotchi-works)
See the [wiki](https://github.com/Pwnagotchi-Unofficial/minigotchi/wiki/How-the-Minigotchi-works).

###
### Hardware
Expand All @@ -52,7 +52,7 @@ See the [wiki](https://github.com/Pwnagotchi-Unofficial/minigotchi/wiki/Hardware

###
### To do
See this [project](https://github.com/orgs/Pwnagotchi-Unofficial/projects/4)
See this [project](https://github.com/orgs/Pwnagotchi-Unofficial/projects/4).
###
### Contributing

Expand Down

0 comments on commit 5b9fb41

Please sign in to comment.