Skip to content

Commit 9f6d206

Browse files
committed
New folder structure and documentation format
well, it's initial form
1 parent 96e1768 commit 9f6d206

File tree

5 files changed

+31
-36
lines changed

5 files changed

+31
-36
lines changed

DEVELOPMENT.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# 🔧 Getting started
2+
3+
> If you want to help developing freebuddy, most important thing you HAVE to know is that **you're very welcome in here 🤗**
4+
>
5+
> I wish that one day, freebuddy could be a single app for *all* headphones, and I just couldn't even **buy** all of them myself 💸
6+
>
7+
> Thus, whole documentation in this repo is made for you 🫵 - if you carefully read it, everything should be clear - if something isn't, let me know 🙌
8+
9+
# 🎧 Adding new headphones
10+
11+
# 🤖 Reverse engineering
12+
13+
# 📱 UI
14+
15+
This document should be:
16+
1. A declaration of how contributing on freebuddy looks like - where to look for help, what to read etc
17+
2. A lighthouse/map to all other .md files about specific fields, that is:
18+
- freebudy architecture/workings - in lib/README.md
19+
- adding new headphones - in lib/headphones/README.md
20+
- hp's with new features - still in lib/hp/README.md, but with some conotations to global readme.. ? idk
21+
- adding new features - widgets etc - in lib/README.md
22+
- reverse engineering - in... idk where
23+
- lastgimbus.com couuuld provide some useful javascript applets, tho it may make more sense to just link to existing ones

lib/README.md

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
1-
# Hi!!!!!! 👋👋👋👋👋
2-
You're coding and want to help out/explore around here? That's great!!!
1+
# freebuddy's architecture
32

4-
Okay, so - UI code is as pure-flutter-future-stream as possible, and most stuff has comments/documentation, so just look around and read those 👍
5-
6-
Interesting rev-eng stuff is in `headphones/` folder, and there is dedicated [headphones/README.md](headphones/README.md) - head there 🫡
7-
8-
# Development notes - philosophies, TODOs etc
9-
10-
## Migration to framework-ish organisation
11-
TODO:
12-
- [X] Implement basic stuff (ANC + battery)
13-
- [X] Change ui to work at all with new stuff
14-
- [ ] Implement hp settings
15-
This is non trivial cause we have to decide how to make this universal when almost all headphones have this different
16-
- [X] Change ui BIG to dynamically support *all* headphones by their features instead of concrete model -> pretty much done?
17-
- [ ] Support multiple diff/same headphones
18-
- [ ] Basic fix in connection loops to show them at all
19-
- [ ] Basic fix in widget to maybe show their name to distinguish which ones are shown now
20-
Currently, widget just creates the cubit, wait until it connects, and gets the battery. What if there are
21-
multiple headphones? Right now it just... gets the first one 🤷
22-
- [ ] Some database stuf... ehhhh... to distinguish between them, remember their last time etc
23-
This is potentially waaayyy ahead todo as it requires *serious* decisions that will affect *everything* wayyy ahead in later development, so better not fuck it up
24-
- [ ] Selecting headphones when making new widget
25-
- [ ] Tests for everything
26-
27-
## Future features:
28-
- [ ] Detect hp colors and assign proper image
29-
- [ ] ANC control widget
30-
This will require whole big background stuff, so that's far offs
3+
Wow that's bold.

lib/headphones/huawei/freebuds3i/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
33
# 🪪 Device description
44

5-
| Vendor | Name | Release year | Type |
6-
|---|---|---|---|
7-
| Huawei | FreeBuds 3i | 2020 | Fully wireless earbuds |
5+
| Vendor | Name | Release year | Type | Support |
6+
|---|---|---|---|---|
7+
| Huawei | FreeBuds 3i | 2020 | Fully wireless earbuds | In progress ⌛ |
88

99
- Vendor's page: https://consumer.huawei.com/sa-en/support/accessories/freebuds-3i/
1010
- Vendor's app: https://consumer.huawei.com/en/mobileservices/ai-life/

lib/headphones/huawei/freebuds4i/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
33
# 🪪 Device description
44

5-
| Vendor | Name | Release year | Type |
6-
|---|---|---|---|
7-
| Huawei | FreeBuds 4i | 2021 | Fully wireless earbuds |
5+
| Vendor | Name | Release year | Type | Support |
6+
|---|---|---|---|---|
7+
| Huawei | FreeBuds 4i | 2021 | Fully wireless earbuds | Full ✅ |
88

99
- Vendor's page: https://consumer.huawei.com/sa-en/headphones/freebuds4i/
1010
- Vendor's app: https://consumer.huawei.com/en/mobileservices/ai-life/

notes/mbb-protocol-wiki.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)