Skip to content

Commit ca3e012

Browse files
authored
docs: improve / correct README (#9)
1 parent c3dad27 commit ca3e012

File tree

2 files changed

+53
-23
lines changed

2 files changed

+53
-23
lines changed

.github/icon.svg

Lines changed: 22 additions & 0 deletions
Loading

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
1-
# Emacs with native compilation ("gcc") + Wayland support
1+
<!-- prettier-ignore-start -->
2+
<div align="center">
3+
<img src=".github/icon.svg" width="200" />
4+
</div>
5+
<!-- prettier-ignore-end -->
26

3-
If the answer to those is "yes":
7+
# Emacs with native compilation ("gcc") and Wayland support
48

5-
- Do you want to use Emacs with native compilation enabled?
6-
- Do you want to use Emacs with Wayland support?
7-
- [Optional] Are you using Arch Linux?
9+
Because [native-comp](https://www.emacswiki.org/emacs/GccEmacs) is
10+
[fast](https://akrl.sdf.org/gccemacs.html),
11+
[Wayland/GTK3 support](https://github.com/masm11/emacs) means optimal HiDPI,
12+
cleaner/simpler dependencies, no XWayland, etc. This package is also a
13+
convenient way of using the "devel" version of Emacs without having to compile
14+
it yourself.
815

9-
Then you might be interested in this repository. If you want all of those but
10-
you are not using Arch Linux, you can still go to the
11-
[release page](https://github.com/mpsq/emacs-gcc-wayland-devel-builder/releases)
12-
and grab the latest binaries.
16+
Note: we do not patch / amend or modify Emacs directly, this is a _vanilla_
17+
binary of Emacs with specific compilation flags.
1318

14-
# What is this?
19+
# How to get it
1520

16-
This repository is just a factory that creates Emacs binaries for `x64` so you
17-
don't have to do it yourself. The base Emacs branch that this repo builds can be
18-
found at [github.com/flatwhatson/emacs](https://github.com/flatwhatson/emacs).
21+
## Arch Linux
1922

20-
Arch Linux users can install the binaries directly from `AUR` using the
21-
[emacs-gcc-wayland-devel-bin](https://aur.archlinux.org/packages/emacs-gcc-wayland-devel-bin/)
22-
package.
23+
Use the `AUR`
24+
[package](https://aur.archlinux.org/packages/emacs-gcc-wayland-devel-bin/):
2325

24-
# Why?
26+
```sh
27+
yay -S emacs-gcc-wayland-devel-bin # or any other AUR helper
28+
```
2529

26-
Because [native comp](https://www.emacswiki.org/emacs/GccEmacs) is
27-
[fast](https://akrl.sdf.org/gccemacs.html),
28-
[wayland support](https://github.com/masm11/emacs) means optimal hidpi support,
29-
and you now have a convenient way of using the "devel" version of Emacs without
30-
having to compile it yourself.
30+
## Others
31+
32+
If you are not using Arch Linux, you can still go to the
33+
[release page](https://github.com/mpsq/emacs-gcc-wayland-devel-builder/releases)
34+
and grab the latest binaries.
35+
36+
Based on demand, I might add compiled packages for other Linux distributions, if
37+
you are interested, let me know in the
38+
[issues](https://github.com/mpsq/emacs-gcc-wayland-devel-builder/issues).
3139

3240
# I want to improve X
3341

@@ -43,4 +51,4 @@ Please create an issue (or, even better, a PR).
4351
# Related
4452

4553
[github.com/fejfighter/pgtk-emacs-flatpak](https://github.com/fejfighter/pgtk-emacs-flatpak)
46-
is the same as this repository but based on Flatpak.
54+
is similar but based on Flatpak.

0 commit comments

Comments
 (0)