Skip to content

Commit

Permalink
adopt readme file from old repo
Browse files Browse the repository at this point in the history
  • Loading branch information
railwaycat committed Aug 25, 2015
1 parent 9f1e9cf commit 8f46775
Showing 1 changed file with 44 additions and 24 deletions.
68 changes: 44 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,52 @@
# Homebrew-emacsmacport
### Usage
##### Enable:
```
brew tap railwaycat/emacsmacport
```
# Emacs Mac Port

##### Install:
```
brew install emacs-mac
```
## What is this? ##

Note: Prepending `{brew --prefix}/share/info` to your `INFOPATH` is suggested to access the info files. For example:
This is "Mac port" addition to GNU Emacs 24. This provides a native
GUI support for Mac OS X 10.4 - 10.10. Note that Emacs 23 and later
already contain the official GUI support via the NS (Cocoa) port for
Mac OS X 10.4 and later. So if it is good enough for you, then you
don't need to try this.

```
export INFOPATH='/usr/local/share/info:/usr/share/info'
```
#### IMPORTANT NOTE ####

If you use [cask](http://caskroom.io/), run:
If you find a bug, then please try to reproduce it with some
official builds such as X11 or NS (Cocoa). If it turns out to be
specific to the Mac port, then please report it to
<a href="mailto:mituharu+bug-gnu-emacs-mac@math.s.chiba-u.ac.jp">mituharu+bug-gnu-emacs-mac@math.s.chiba-u.ac.jp</a>. Otherwise (i.e.,
it is also reproducible with official ones), report it using <kbd>M-x</kbd>
report-emacs-bug *USING THE OFFICIAL BUILD* as such.

```
brew cask install emacs-mac
```
## Features ##
This build has *many* features, a great number of which are particularly helpful for Mac users. You can see the full list <a href="https://github.com/railwaycat/mirror-emacs-mac/blob/master/README-mac">here</a>.

##### Disable:
```
brew untap railwaycat/emacsmacport
```

### Pre-built binaries
## Installation options ##

Please see [here](https://github.com/railwaycat/homebrew-emacsmacport/releases)

### Homebrew ###
If you'd like to install with Homebrew, please

`$ brew tap railwaycat/emacsmacport`

and then

`$ brew install emacs-mac`

if you using cask

`brew cask install emacs-mac`

To disable this tap, please:

`$ brew untap railwaycat/emacsmacport`

### Pre-built Download ###

https://github.com/railwaycat/homebrew-emacsmacport/releases

## Useful links ##

* Switch meta and option key - https://gist.github.com/3498096

* An Emacs.app CLI starter, modified from Aquamacs - https://gist.github.com/4043945

0 comments on commit 8f46775

Please sign in to comment.