Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inscapist/emacs-osx
Emacs on Mac OSX. Install with Nix
https://github.com/inscapist/emacs-osx
big-sur catalina darwin emacs gccemacs macos native-comp nix nixpkgs osx
Last synced: about 8 hours ago
JSON representation
Emacs on Mac OSX. Install with Nix
- Host: GitHub
- URL: https://github.com/inscapist/emacs-osx
- Owner: inscapist
- License: mit
- Archived: true
- Created: 2021-04-27T16:11:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-21T15:47:10.000Z (almost 3 years ago)
- Last Synced: 2024-09-24T01:04:17.234Z (4 days ago)
- Topics: big-sur, catalina, darwin, emacs, gccemacs, macos, native-comp, nix, nixpkgs, osx
- Language: Nix
- Homepage:
- Size: 145 KB
- Stars: 40
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Emacs OSX
## Features
- Tested on Mac OSX Big Sur and Catalina
- Works with yabai tiling window manager
- Comes with 4 variants (with/without native-compilation, and with/without tiling support)
- Cached builds, updated from source every 24 hours
## There are 4 variants
#### emacsOsx
> master emacs. Fresh out of https://savannah.gnu.org/projects/emacs
#### emacsOsxNative
> master emacs, with native compilation
#### emacsOsxTile
> emacsOsx with tiling support (may not work with posframe/childframe)
#### emacsOsxNativeTile
> emacsOsxNative with tiling support (may not work with posframe/childframe)
## Installation
#### Install Nix and optionally nix-darwin
No Nix knowledge required, and you do NOT need `nix-darwin` for this to work. [Nix Darwin](https://github.com/LnL7/nix-darwin) allows installation to /Applications folder but you could also symlink from `~/.nix-profile/Applications`.
Visit this link if you haven't installed Nix already.
https://nixos.org/guides/install-nix.html
#### Install to nix-store
```sh
# Install from cachix binaries
nix-env -iA cachix -f https://cachix.org/api/v1/install
cachix use emacs-osx
# `emacsOsxNative` can be substituted with any variant (mentioned above)
nix-env -iA emacsOsxNative -f https://github.com/sagittaros/emacs-osx/archive/refs/tags/built.tar.gz
```
#### Copy to /Applications
Not required if you are using nix-darwin.
```sh
sudo rm -rf /Applications/Emacs.app
sudo cp -rL ~/.nix-profile/Applications/Emacs.app /Applications
```
## Motivation
- Replicate [Emacs Overlay](https://github.com/nix-community/emacs-overlay) to OSX/darwin environment
- Allow overrides of patches
- Last but not least, for my own learning and use
- And in future (my own custom icons)
## Patches
More patches can be found below:
- [daviderestivo's emacs-head](https://github.com/daviderestivo/homebrew-emacs-head/tree/master/patches)
- [Emacs plus](https://github.com/d12frosted/homebrew-emacs-plus/tree/master/patches/emacs-28)
- [Emacs overlay](https://github.com/nix-community/emacs-overlay/tree/master/patches)
Note that this uses --with-ns (nextstep) and patches from "Mac Port" (see [here](https://bitbucket.org/mituharu/emacs-mac/src/master/)) version will likely not work.
## References
- https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/applications/editors/emacs/generic.nix
- https://github.com/nix-community/emacs-overlay
- https://european-lisp-symposium.org/static/2020/corallo-nassi-manca-slides.pdf
- https://arxiv.org/pdf/2004.02504.pdf
- https://www.gnu.org/software/emacs/manual/html_node/elisp/Building-Emacs.html
## Inspired By
[Gccemacs by twlz0ne](https://github.com/twlz0ne/nix-gccemacs-darwin)
## CI configuration (Github Action)
Refer https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on