Skip to content

Commit 85309b6

Browse files
authored
Merge branch 'master' into arm64
2 parents d385927 + 0ec544c commit 85309b6

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ You simply have to download the latest release.
3030

3131
Simply install the .dmg.
3232

33-
Note that you may have to allow the app for installation and first open under `Settings > Privacy & Security > Security` (you should see a dialog asking for permission.)
33+
Note that you may have to first allow the app to install under `Settings > Privacy & Security > Security` (you should see a dialog asking for permission)
3434

3535
#### Linux
3636

3737
##### Install dependencies
3838

39-
RQuickShare requires one of the following library installed.
39+
RQuickShare requires one of the following libraries to be installed:
4040

4141
- `libayatana-appindicator`
4242
- `libappindicator3`
4343

44-
The files should (in theory) install those dependencies by themselves, but in case this is not the case you may have to install those manually.
44+
The files should (in theory) install those dependencies by themselves, but if this is not the case you may have to install those manually.
4545

4646
##### Install rquickshare
4747
```bash
@@ -79,7 +79,7 @@ You can then either double click on it, or run it from the cmd line:
7979

8080
#### Snap
8181

82-
The snap is not yet on the store, but you can install it with the following (you may need sudo).
82+
The snap is not yet on the store, but you can install it with the following (you may need sudo):
8383

8484
```bash
8585
snap install --dangerous r-quick-share_${VERSION}.snap
@@ -92,15 +92,15 @@ snap install --dangerous r-quick-share_${VERSION}.snap
9292

9393
#### AUR (Arch)
9494

95-
For Arch Linux, you can install it from the AUR by using an AUR helper like yay.
95+
For Arch Linux, you can install it from the AUR by using an AUR helper like yay:
9696

9797
```bash
9898
yay -S r-quick-share
9999
```
100100

101101
### Nix
102102

103-
Available here: [NixOS](https://search.nixos.org/packages?channel=24.05&show=rquickshare&from=0&size=50&sort=relevance&type=packages&query=rquickshare):
103+
Available here: [NixOS](https://search.nixos.org/packages?channel=24.05&show=rquickshare&from=0&size=50&sort=relevance&type=packages&query=rquickshare)
104104

105105
A nix-shell will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it.
106106

@@ -114,25 +114,25 @@ $ nix-shell -p rquickshare
114114
Limitations
115115
--------------------------
116116

117-
- **Wi-Fi LAN only**. Your devices needs to be on the same network for this app to work.
117+
- **Wi-Fi LAN only**. Your devices need to be on the same network for this app to work.
118118

119119
FAQ
120120
--------------------------
121121

122122
### My Android device doesn't see my laptop
123123

124-
Make sure both your devices are on the same WiFi network. mDNS communication should be allowed on the network; it may not be the case if you're on a public network (coffee shops, airports, ...).
124+
Make sure both your devices are on the same WiFi network. mDNS communication should be allowed on the network; this may not be the case if you're on a public network (coffee shops, airports, etc.).
125125

126126
### My laptop doesn't see my Android device
127127

128-
For some reason, Android doesn't broadcast its mDNS service all the time; even when in "Everyone" mode.
128+
For some reason, Android doesn't broadcast its mDNS service all the time, even when in "Everyone" mode.
129129

130130
The first solution (implemented in RQuickShare for Linux) is to broadcast a bluetooth advertisement so that Android will then make its mDNS available.
131131
Of course, for this you need to have bluetooth on your laptop/desktop. If you don't have that, continue reading.
132132

133-
As a workaround, you can use the "[Files](https://play.google.com/store/apps/details?id=com.google.android.apps.nbu.files)" app on your android device and go to "Nearby Share" tab (if it's not present, continue reading).
133+
As a workaround, you can use the "[Files](https://play.google.com/store/apps/details?id=com.google.android.apps.nbu.files)" app on your Android device and go to the "Nearby Share" tab (if it's not present, continue reading).
134134

135-
A second workaround, you can download a Shortcut maker (see [here](https://xdaforums.com/t/how-to-manually-create-a-homescreen-shortcut-to-a-known-unique-android-activity.4336833)) to create a shortcut to the particular intent:
135+
A second workaround is to download a Shortcut maker (see [here](https://xdaforums.com/t/how-to-manually-create-a-homescreen-shortcut-to-a-known-unique-android-activity.4336833)) to create a shortcut to the particular intent:
136136

137137
- Method A:
138138
- Activity: `com.google.android.gms.nearby.sharing.ReceiveSurfaceActivity`
@@ -143,11 +143,11 @@ A second workaround, you can download a Shortcut maker (see [here](https://xdafo
143143

144144
_Note: Samsung did something shady with Quick Share, so the above workaround may not work. Unfortunately, there's no alternative at the moment. Sorry._
145145

146-
### When sharing a file, my phone appears and disapears "randomly"
146+
### When sharing a file, my phone appears and disappears "randomly"
147147

148148
TLDR: This is normal if you're just using bluetooth (as explained in the previous point).
149149

150-
Android will see that your laptop/desktop is trying to share a file and will reveal itself. But for some reason Android will de-register its service from time to time and will only then be revealed again once it detect the bluetooth message again.
150+
Android will see that your laptop/desktop is trying to share a file and will reveal itself. But for some reason, Android will de-register its service from time to time and will only then be revealed again once it detects the bluetooth message again.
151151

152152
### Once I close the app, it won't reopen
153153

@@ -157,7 +157,7 @@ Make sure the app is really closed by running:
157157
ps aux | grep r-quick-share
158158
```
159159

160-
If you see that the process is still running, it's because the app is not closed. This may be an intended behavior: when closing the window, the app won't stop and instead is still running and accessible via the system tray icon. But if your distribution doesn't support/don't have enabled them, it may be an issue for you.
160+
If you see that the process is still running, it's because the app is not closed. This may be an intended behavior: when closing the window, the app won't stop and instead is still running and accessible via the system tray icon. However, if your distribution doesn't support/hasn't enabled this, it may be an issue for you.
161161

162162
If you want to **really** close the app when clicking on the close button, you can change that inside the app by clicking on the three dots and then "Stop app on close".
163163

@@ -178,7 +178,7 @@ find $HOME -name ".settings.json"
178178

179179
> [!WARNING]
180180
>
181-
> The json must stay valid after your modification, this means if "port" is the last item of the JSON it must not have a comma after it, otherwise the config will be reset.
181+
> The json must stay valid after your modification; for example, if "port" is the last item of the JSON it must not have a comma after it, otherwise the config will be reset.
182182
183183
```json
184184
{
@@ -189,22 +189,22 @@ find $HOME -name ".settings.json"
189189

190190
By default the port is random (the OS will decide).
191191

192-
### The app open but I just get a blank window or cannot run it.
192+
### The app opens but I just get a blank window or cannot run it.
193193

194194
This happens for some users running Linux + NVIDIA cards.
195195

196-
The workaround is to start RQuickShare with an env variable defined as follow:
196+
The workaround is to start RQuickShare with an env variable defined as follows:
197197

198198
```bash
199199
env WEBKIT_DISABLE_COMPOSITING_MODE=1 rquickshare
200200
```
201201

202-
Also you may use `legacy` variant to figure it.
202+
Alternatively, you may try the `legacy` variant.
203203

204204
WIP Notes
205205
--------------------------
206206

207-
`rquickshare` is still in development (WIP) and currently only supports Linux even tho it should be compatible with macOS too. Keep in mind that the design may change between versions, so flexibility is key.
207+
`rquickshare` is still in development (WIP) and currently only supports Linux even though it should be compatible with macOS too. Keep in mind that the design may change between versions, so flexibility is key.
208208

209209
Got feedback or suggestions? We'd love to hear them! Feel free to open an issue and share your thoughts.
210210

0 commit comments

Comments
 (0)