diff --git a/README.md b/README.md index 2479a69a..a2180108 100644 --- a/README.md +++ b/README.md @@ -74,21 +74,63 @@ sudo dnf install -y \ Currently there are no prebuilt shared library or headers. You'll have to build them yourself ### How to build -Check the [wiki](https://github.com/kidfromjupiter/nearby/wiki/Development-Environment-and-Building) +~Check the [wiki](https://github.com/kidfromjupiter/nearby/wiki/Development-Environment-and-Building)~ + +Wiki isn't built yet. Best place to consult would be the Github actions and workflows. ### How to contribute -Check the [wiki](https://github.com/kidfromjupiter/nearby/wiki/Development-Environment-and-Building) +~Check the [wiki](https://github.com/kidfromjupiter/nearby/wiki/Development-Environment-and-Building)~ ## TODO -- ship a prebuilt sdbus 2 -- Investigate why bluetooth connection requests pairing ( both l2cap socket and bluetooth profile should be unauthenticated ) -- When transferring (android to linux) over bluetooth classic, android shows 100% transferred ( but still `Sending...` ) while linux lags behind. Some kind of bottleneck or android bug? -- Tests for basically everything. -- Cleanup of `implementation/linux`. Currently all the linux specific implementation files are in the same directory. Even though thats how the other platforms have their stuff structured, I personally hate the visual bloat. -- Documentation basically everything ( honestly this would be a massive project in itself ) -- Resolving random crashes of quick share application -- Support for fast initiation -- When receiving, if file already exists, does not overwrite currently. Decide what to do then + +> **Development is paused until my next break (around mid-June.)** + +--- + +### 🔴 P0 — Critical / Core Functionality + +> Issues that break core functionality. These should be addressed immediately. + +- **Linux → Android file sharing is unreliable** after the newest Android Quick Share updates. + Investigate why and fix it. Possibly related to proprietary certificate changes. +- **QR code scanning does not work.** + Likely related to the Linux → Android sharing issue above. I did get it working once in a very old build. So it shouldn't impossible. Unless google changed something + +--- + +### 🟠 P1 — Important Annoyances + +> Problems that are not fully blocking, but noticeably affect usability. + +- **Ship a prebuilt `sdbus 2`.** +- **Investigate why Bluetooth connection requests pairing.** + Both the L2CAP socket and Bluetooth profile should be unauthenticated. +- **Handle existing files when receiving.** + Currently, files are not overwritten if they already exist. Decide whether to overwrite, rename, or skip. + +--- + +### 🟡 P2 — Quality of Life / Cleanup + +> Improvements that would make the project cleaner, smoother, or easier to maintain. + +- **Bluetooth Classic transfer progress issue.** + When transferring Android → Linux, Android shows 100% transferred but still says `Sending...`, while Linux lags behind. Could be a bottleneck or Android-side issue. +- **Add tests for basically everything.** +- **Clean up `implementation/linux`.** + Linux-specific implementation files are currently all in one directory. This matches the other platforms, but creates visual bloat. +- **Document basically everything.** + This would be a large project on its own. +- **Resolve random crashes in the Quick Share application.** + +--- + +### 🔵 P3 — New Features + +> Non-essential features and future improvements. + +- **Support fast initiation.** + ## Apologies I may have done things in *incredibly* stupid and overcomplicated ways. It doesn't certainly help that this was the way I decided to learn C++. Blessed be my naive soul. I also do not have much experience working with such