Skip to content

Commit eac2813

Browse files
authored
Merge pull request randy3k#7 from HedenEnterprises/master
Attempting to improve the README
2 parents 32e4032 + b5e515f commit eac2813

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

README.md

+32-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# RemoteSubl
22

3-
RemoteSubl starts as a fork of [rsub](https://github.com/henrikpersson/rsub) to bring `rmate` feature of TextMate to Sublime Text. It transfers files to be edited from remote server using SSH port forward and transfers the files back when they are saved.
3+
RemoteSubl starts as a fork of [rsub](https://github.com/henrikpersson/rsub) to
4+
bring `rmate` feature of TextMate to Sublime Text. It transfers files to be
5+
edited from remote server using SSH port forward and transfers the files back
6+
when they are saved.
47

58
Comparing to rsub, the followings are enhanced:
69

@@ -11,15 +14,22 @@ Comparing to rsub, the followings are enhanced:
1114
- better status bar messages when saving file and when encountering errors.
1215
- bring up Sublime Text on different platforms.
1316

14-
Why a new fork? It seems that the author of rsub is not actively maintaining that package.
15-
17+
Why a new fork? It seems that the author of rsub is not actively maintaining
18+
that package.
1619

1720
# Installation
1821

19-
RemoteSubl can easily be installed using [Package Control](https://packagecontrol.io).
22+
Before installing on your remote server, RemoteSubl can easily be installed
23+
using [Package Control](https://packagecontrol.io).
24+
25+
Once you have that completed, open up Sublime Text *(the rest won't work unless
26+
you do)*.
2027

21-
On the remote server, we need to install [rmate](https://github.com/aurora/rmate) (this one is the bash version). You don't have to install it if you have been using `rmate` with TextMate or other editors.
22-
It is just the same executable. If not, it (the bash version) can be installed by running this script (assume that you have the right permission),
28+
On the remote server, we need to install
29+
[rmate](https://github.com/aurora/rmate) (this one is the bash version). You
30+
don't have to install it if you have been using `rmate` with TextMate or other
31+
editors. It is just the same executable. If not, it (the bash version) can be
32+
installed by running this script (assuming you have the right permission),
2333

2434
```bash
2535
curl -o /usr/local/bin/rmate https://raw.githubusercontent.com/aurora/rmate/master/rmate
@@ -32,7 +42,8 @@ You can also rename the command to `rsubl`
3242
mv /usr/local/bin/rmate /usr/local/bin/rsubl
3343
```
3444

35-
If your remote system does not have `bash` (so what else does it have?), there are different versions of `rmate` to choose from:
45+
If your remote system does not have `bash` (so what else does it have?), there
46+
are different versions of `rmate` to choose from:
3647

3748
- The official ruby version: https://github.com/textmate/rmate
3849
- A bash version: https://github.com/aurora/rmate
@@ -44,32 +55,37 @@ If your remote system does not have `bash` (so what else does it have?), there a
4455

4556
# Usage
4657

47-
Open an ssh connection to the remote server with remote port forwarded.
48-
It can be done by
58+
Open an ssh connection to the remote server with remote port forwarded. It can
59+
be done by executing the following command on your local machine:
4960

5061
```bash
5162
ssh -R 52698:localhost:52698 [email protected]
5263
```
5364

54-
After running the server, you can just open the file on the remote system by
55-
56-
(NOTE: you need to have opened Sublime on you local machine.
57-
If not you get this error connect_to localhost port 52698: failed.)
65+
After running the server, you can just open the file by typing the following
66+
command in your remote system's terminal:
5867

5968
```
6069
rmate test.txt
6170
```
71+
72+
(***NOTE:*** you need to have opened Sublime Text on your local machine.
73+
*If not* you get this error: `connect_to localhost port 52698: failed.` on your
74+
server)
75+
6276
... or if you renamed it to `rsubl` then ...
6377

6478
```
6579
rsubl test.txt
6680
```
6781

68-
If everything has been setup correctly, your should be able to see the opening file in Sublime Text.
82+
If everything has been setup correctly, you should be able to see the opening
83+
file in Sublime Text.
6984

7085
### SSH config
71-
It could be tedious to type `-R 52698:localhost:52698` everytime you ssh. To make your
72-
life easier, add the following to `~/.ssh/config`,
86+
87+
It could be tedious to type `-R 52698:localhost:52698` everytime you ssh. To
88+
make your life easier, add the following to `~/.ssh/config`,
7389

7490
```
7591
Host example.com

0 commit comments

Comments
 (0)