update readme
This commit is contained in:
parent
4501e333f0
commit
69ae823e68
4 changed files with 30 additions and 7 deletions
36
README.md
36
README.md
|
@ -22,15 +22,37 @@ Raptor codes for that file. Each piece of Raptor code then gets encoded as a QR
|
|||
displayed for a period of time on the screen. The user then holds up the receiving computer's camera
|
||||
in order to receive the QR encoded raptor codes, and, *voila*, the file has been transferred!
|
||||
|
||||
# Current status
|
||||
# Current status (2023-08-20)
|
||||
|
||||
The desktop transmitting application is nearly done; already it can convert text input into QR codes
|
||||
(either a single static one if the data is small enough, otherwise it will stream a never ending
|
||||
loop of them), and the mobile app has been started. Even without the mobile app, it's still
|
||||
already useful for transmitting short text strings to the phone, since the Android camera app will
|
||||
decode any detected QR codes.
|
||||
Currently, the following is done in terms of functionality:
|
||||
|
||||
**Desktop**
|
||||
- [x] transmit short text given on the commandline with a single qr code
|
||||
- [x] transmit large text given on the commandline with a stream of qr codes
|
||||
- [x] transmit small files given on the commandline with a single qr code
|
||||
- [x] transmit large files given on the commandline with a stream of qr codes
|
||||
- [ ] receive text or files with a single qr code
|
||||
- [ ] receive text or files with a stream of qr codes
|
||||
|
||||
**Android app**
|
||||
- [ ] transmit short given text with a single qr code
|
||||
- [ ] transmit large given text with a stream of qr codes
|
||||
- [ ] transmit small files with a single qr code
|
||||
- [ ] transmit large files with a stream of qr codes
|
||||
- [x] receive text or files with a single qr code
|
||||
- [x] receive text or files with a stream of qr codes
|
||||
|
||||
The desktop app (unix-ish only; developed on linux, untested on anything else, but should run on macos)
|
||||
is closer to its final form in terms of UI/UX, though it currently can only transmit. The Android
|
||||
app is about halfway done in terms of functionality, but the UI is, shall we say, "hideous":
|
||||
|
||||
![cuttle mobile app receiving data](./mobile_receiving.png) ![cuttle mobile app done receiving
|
||||
data](./mobile_finished.png)
|
||||
|
||||
I might take a crack at making it less hideous before I start on the mobile transmitting/desktop
|
||||
receiving side of the functionality, but maybe not! I often want to transfer a file or text from my
|
||||
phone to my desktop, and I'm willing to live with an ugly UI for a little bit.
|
||||
|
||||
The mobile app has been started, and I hope to have it decoding QR streams soon!
|
||||
|
||||
# about the name
|
||||
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
org.gradle.jvmargs=-Xmx1536M
|
||||
android.useAndroidX=true
|
||||
android.enableJetifier=true
|
||||
org.gradle.daemon=false
|
||||
|
|
BIN
mobile_finished.png
Normal file
BIN
mobile_finished.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 816 KiB |
BIN
mobile_receiving.png
Normal file
BIN
mobile_receiving.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 698 KiB |
Loading…
Reference in a new issue