Skip to content

Commit c473714

Browse files
committed
docs: add README
1 parent bfb7e2d commit c473714

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
# Coming soon...
1+
# Emacs with native compilation ("gcc") + Wayland support
2+
3+
If the answer to those is "yes":
4+
5+
- Do you want to use Emacs with native compilation enabled?
6+
- Do you want to use Emacs with Wayland support?
7+
- Are you using Arch Linux?
8+
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.
13+
14+
# What is this?
15+
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).
19+
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+
24+
# I want to improve X
25+
26+
Please create an issue (or, even better, a PR).
27+
28+
# Thanks
29+
30+
All the hard work is done by other people:
31+
32+
- [github.com/masm11](https://github.com/masm11) for the Wayland support
33+
- [github.com/flatwhatson](https://github.com/flatwhatson) for maitaining a
34+
[clean branch](https://github.com/flatwhatson/emacs) with Wayland support
35+
- [github.com/VitalyAnkh](https://github.com/VitalyAnkh) for
36+
[emacs-native-comp-git-enhanced](https://aur.archlinux.org/packages/emacs-native-comp-git-enhanced/)
37+
- Obviously [core Emacs maintainers](https://www.gnu.org/people/people.en.html)!
38+
39+
# Related
40+
41+
[github.com/fejfighter/pgtk-emacs-flatpak](https://github.com/fejfighter/pgtk-emacs-flatpak)
42+
is the same as this repository but based on Flatpak.

0 commit comments

Comments
 (0)