You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixes#22.
Also update the build process:
* Libraries are no longer bundled together with application codes, and
output under `out/ext/lib` instead.
* Add a Makefile.
label: What new features would you like us to add to Ghostbird?
8
+
label: Is your feature request related to a problem you are experiencing? Please describe.
9
+
placeholder: A clear and concise description of what the problem is. e.g., I have an issue when doing [...]
10
+
validations:
11
+
required: false
12
+
- type: textarea
13
+
attributes:
14
+
label: Describe the solution you'd like.
15
+
placeholder: A clear and concise description of what you want to happen, together with any potential drawbacks.
9
16
validations:
10
17
required: true
18
+
- type: textarea
19
+
attributes:
20
+
label: Describe alternative solutions if any.
21
+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
22
+
validations:
23
+
required: false
24
+
- type: textarea
25
+
attributes:
26
+
label: Please provide information about documentation, adoption, migration strategy.
27
+
placeholder: If possible, explain how users would adopt this feature and provide a draft of the documentation. Preferably include a screenshot or a design sketch.
[](#installation)
9
+
8
10
A [GhostText][gt] implementation for the [Thunderbird][tb] email client.
9
11
10
12
This repo contains an in-development Thunderbird add-on that works as a [GhostText client][protocol] in the mail compose window, so that users can write their emails in their favorite text editor like Vim (provided the text editor already has a GhostText add-on installed).
@@ -24,32 +26,46 @@ This repo contains an in-development Thunderbird add-on that works as a [GhostTe
The last two implementations can wrap any editor that behaves like Notepad.
29
+
The last two implementations can wrap any editor that blocks while editing.
28
30
29
31
## Installation
30
32
31
33
[<imgsrc="./ext/blue.svg"width="48"height="48"border="1"align="right"alt="logo"title="Grey-headed bushshrike (Malaconotus blanchoti) is sometimes called 'ghostbird'">][bird]
32
34
33
-
This add-on is not yet available on [addons.thunderbird.net](https://addons.thunderbird.net/). You can install it manually or build it from source.
35
+
* See [the help page in the Mozilla Support Center](https://support.mozilla.org/kb/installing-addon-thunderbird) for details.
36
+
37
+
You can install Ghostbird in several ways:
38
+
39
+
### Install within Thunderbird (Recommended)
40
+
41
+
1. In Thunderbird, open `Add-ons Manager`.
42
+
2. Search for "Ghostbird".
43
+
3. Click the <kbd>+ Add to Thunderbird</kbd> button.
34
44
35
-
### Manual Installation
45
+
### Download and install manually
36
46
37
-
1. Download the latest release from [Releases][rels].
38
-
2. In Thunderbird, go to `Add-ons Manager` and Press :gear: button at the top-right.
39
-
3. Select `Install Add-on From File...` from the menu.
40
-
4. Select downloaded `.xpi` file.
47
+
[][amo]
41
48
42
-
See [the help page in the Mozilla Support Center](https://support.mozilla.org/kb/installing-addon-thunderbird) for details.
49
+
1. Download the latest release from [AMO][amo] or [Github Releases][rels].
50
+
2. In Thunderbird, go to `Add-ons Manager`.
51
+
3. Drag and drop the downloaded `.xpi` file into the `Add-ons Manager` window.
52
+
53
+
Alternatively, you can:
54
+
55
+
3. Press :gear: button at the top-right.
56
+
4. Select `Install Add-on From File...` from the menu.
57
+
5. Select downloaded `.xpi` file.
43
58
44
59
### Build from source
45
60
46
-
Basically `yarn && yarn build`. See [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
61
+
* Basically, `make` will do, which internally calls `yarn install && yarn build`.
62
+
* See [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
47
63
48
64
## Usage
49
65
50
66
1. Launch your favorite text editor.
51
-
2. Start GhostText server in your text editor (e.g. with `:GhostTextStart` in Vim).
52
-
3. Press the gray Ghostbird button <imgsrc="./ext/gray.svg"width="24"height="24"border="1"> in the Thunderbird mail compose window. (The default shortcut is <kbd>Ctrl</kbd>+<kbd>E</kbd>)
67
+
2. Start the GhostText server in your text editor (e.g., with `:GhostTextStart` in Vim).
68
+
3. Press the gray Ghostbird button <imgsrc="./ext/gray.svg"width="24"height="24"border="1"> in the Thunderbird mail compose window. (The default shortcut is <kbd>^Ctrl</kbd>+<kbd>⇧Shift</kbd>+<kbd>H</kbd>)
53
69
* If the connection is successful, the button will turn blue <imgsrc="./ext/blue.svg"width="24"height="24"border="1">.
54
70
* If the connection fails, the button will turn red <imgsrc="./ext/red.svg"width="24"height="24"border="1">. Make sure that the GhostText server is listening. See [Troubleshooting page of original GhostText](https://ghosttext.fregante.com/troubleshooting/#unable-to-connect).
* Feel free to open issues and submit pull requests. See [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
@@ -169,7 +188,7 @@ We need help with:
169
188
* Wiki pages for [user guides](https://github.com/exteditor/ghostbird/wiki/HowTo) and [troubleshooting](https://github.com/exteditor/ghostbird/wiki/Troubleshooting)
170
189
* Developing the server counterpart so that this can be used as an External Editor replacement ([GhostText-Any](https://github.com/newsch/GhostText-Any/) or [Helix-Ghost][helix] can be a good starting point)
171
190
* Creating a testing checklist for testing and debugging ([This page](https://github.com/exteditor/exteditor/wiki/Things-to-test) can be a good starting point)
172
-
* Automating test with the real Thunderbird (See [Testing](./doc/testing.md))
191
+
* Automating tests with the real Thunderbird (See [Testing](./doc/testing.md))
173
192
* Organization members (I want to increase [the bus factor](https://en.wikipedia.org/wiki/Bus_factor) of [the organization](https://github.com/exteditor/))
174
193
175
194
## FAQ
@@ -178,8 +197,8 @@ We need help with:
178
197
179
198
* I'd say yes, but save your work frequently since it may contain bugs and eat your email.
180
199
* This add-on does not collect any personal data and can only connect to localhost. Attempts to send any data to external servers are blocked by Thunderbird's security model.
181
-
* You can look inside the released `.xpi` files (which are just zip files) to verify that it matches the build from the source code.
182
-
* As for trustworthiness, the safest option is to wait until it is published on AMO, as that indicates it has passed Mozilla's review process.
200
+
* You can look inside the released `.xpi` files (which are just zip files) to verify that they match the build from the source code.
201
+
* As for trustworthiness, the safest option is to wait until it reaches 1.0.0, as that indicates it has passed Mozilla's manual review.
183
202
184
203
### Why not just fork the original GhostText add-on, or contribute to it?
185
204
@@ -216,7 +235,7 @@ If you've looked at the options above and still want to motivate the maintainer
216
235
217
236
*[Federico Brigante](https://fregante.com/), the author of [GhostText][gt].
218
237
*[Alexandre Feblot](https://github.com/afeblot), the original author of [External Editor](https://github.com/exteditor/exteditor/), which I took over maintaining; it is now in a stale state. I intend to incorporate some of its features into Ghostbird.
219
-
* The button image is based on [photo](https://commons.wikimedia.org/wiki/File:Grey-headed_Bushshrike_(Malaconotus_blanchoti)_in_tree,_crop.jpg) of a [Grey-headed Bushshrike][bird] by [Patty McGann](https://www.flickr.com/photos/10374910@N08/3093177192/) (CC-BY-2.0).
238
+
* The button image is based on a [photo](https://commons.wikimedia.org/wiki/File:Grey-headed_Bushshrike_(Malaconotus_blanchoti)_in_tree,_crop.jpg) of a [Grey-headed Bushshrike][bird] by [Patty McGann](https://www.flickr.com/photos/10374910@N08/3093177192/) (CC-BY-2.0).
220
239
221
240
### Tools
222
241
@@ -246,3 +265,4 @@ Ghostbird is [dual-licensed under (MPL-2.0 OR GPL-3.0-or-later)](./LICENSE). See
0 commit comments