Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add recommended brew method to install emacs #10677

Merged
merged 3 commits into from
May 21, 2018

Conversation

athersharif
Copy link
Contributor

Seems like brew linkapps emacs-plus doesn't work anymore. This PR updates the README with the updated recommended method from brew in order to install emacs.

@fiveNinePlusR
Copy link
Contributor

this needs to be rebased on develop. there are way too many commits here.

as to your commit... why is this cask now the suggested way? i think emacs-mac is a better formula all around as it lets you install with a bunch of different versions and options.

@athersharif
Copy link
Contributor Author

@fiveNinePlusR sorry for the conflicts. fixed now.

this is as per the emacs wiki.

@fiveNinePlusR
Copy link
Contributor

I think the wiki is out of date. the better way to install the gui emacs for cocoa is through emacs-mac from homebrew proper instead of the binary blobs that have fewer options.

@syl20bnr
Copy link
Owner

syl20bnr commented May 15, 2018 via email

@athersharif
Copy link
Contributor Author

@fiveNinePlusR @syl20bnr i'm fine either way but here are my two cents:

i think what makes spacemacs so awesome is that it's a one stop shop and has the documentation to start a newbie from start to finish. imo, removing the linkapps with something else would make things a little bit complex. how would you guys think about just linking to https://www.emacswiki.org/emacs/EmacsForMacOS#toc12 for emacs installation so users can pick whatever they're comfortable with, and may be adding your preferred choice from that list?

thoughts?

@syl20bnr
Copy link
Owner

syl20bnr commented May 15, 2018 via email

@athersharif athersharif force-pushed the patch-1 branch 2 times, most recently from f77cafa to 7d679bd Compare May 15, 2018 15:58
@athersharif
Copy link
Contributor Author

@syl20bnr updated the PR. let me know if you guys want me to change it more. :)

@fiveNinePlusR
Copy link
Contributor

looks good to me. I think the best one is the emacs-mac tap, but that's a tap and is (very) slightly more complex to install from homebrew. (one extra step). Linking to that page at that part gives the user all the info they really need.

@htc502
Copy link

htc502 commented May 16, 2018

As a user, I think this edition is not good enough. It makes me more confused:

  1. I am redirected to another 'long list' (probably longer than spacemacs readme.) which I think is not quite user friendly.
  2. That wikipage also uses 'brew linkapps emacs' to 'finally link it to your Applications folder'. As I've tested, brew linkapps is already deprecated. This is the problem that the RP want to deal with.

If you guys think emacs-mac is a good way to go, probably you can link the user to that specific part or just copy that part over here.
To me, the following command saved me for linking the app to Application:
'ln -s /usr/local/Cellar/emacs/24.5/Emacs.app /Applications'
Not sure we can do this in readme or not.
Hope this is helpful. Thank you.

@athersharif
Copy link
Contributor Author

@htc502 i can totally see the confusion there. and you're right, this might be too big a documentation to link to and the wiki not supporting navigation by id doesn't help either. before we had the conversation above, i was initially in the favor of the following:

Cask homebrew installation
Homebrew now recommends to use the cask version with the following message: “Please try the Cask for a better-supported Cocoa version”

To install the cask version:

brew cask install emacs
This installs a pre-built package from https://emacsformacosx.com/

also, the symlink you posted above is for 24.5. this version would have to be kept like [version] or something similar if we were to add this to the readme, imo.

@fiveNinePlusR @syl20bnr - thoughts? are we inclining towards emacs-plus or emacs-mac?

@fiveNinePlusR
Copy link
Contributor

fiveNinePlusR commented May 16, 2018

when you install emacs-mac it shows the following in the terminal:

This is YAMAMOTO Mitsuharu's "Mac port" addition to
GNU Emacs 26. This provides a native GUI support for Mac OS X
10.6 - 10.13. After installing, see README-mac and NEWS-mac
in /usr/local/Cellar/emacs-mac/emacs-26.1-rc1-mac-6.90 for the port details.

Emacs.app was installed to:
  /usr/local/Cellar/emacs-mac/emacs-26.1-rc1-mac-6.90

To link the application to default Homebrew App location:
  brew linkapps
or:
  ln -s /usr/local/Cellar/emacs-mac/emacs-26.1-rc1-mac-6.90/Emacs.app /Applications
Other ways please refer:
  https://github.com/railwaycat/homebrew-emacsmacport/wiki/Alternative-way-of-place-Emacs.app-to-Applications-directory

For an Emacs.app CLI starter, see:
  https://gist.github.com/4043945

I would say that it should be sufficient to highlight how to install it. It's an advanced editor and you have to assume a basic level of competency at the end of the day.

If you want to make it clear I would say just use the cask version like you had but indicate that there are other versions with various tradeoffs and link to that wikipedia page.

edit:

is this too hard of an installation?

brew tap railwaycat/emacsmacport
brew install emacs-mac
copy and paste the ln from the install instructions if brew linkapps is deprecated

@athersharif
Copy link
Contributor Author

@fiveNinePlusR thanks for the great suggestion. really like it :).

i've updated the PR. thoughts?

@fiveNinePlusR
Copy link
Contributor

looks good to me. might want to downcase the ln statement though.

@athersharif
Copy link
Contributor Author

ah, sorry about that. updated.

@syl20bnr
Copy link
Owner

syl20bnr commented May 18, 2018 via email

@athersharif
Copy link
Contributor Author

@syl20bnr - added the emacs-plus instructions in there as well. also, probably should keep an eye on d12frosted/homebrew-emacs-plus#41 (comment) and update the readme when this change is made in the future.

@athersharif
Copy link
Contributor Author

also, @syl20bnr @fiveNinePlusR - any idea why the Emacs24 build is failing?

@syl20bnr
Copy link
Owner

syl20bnr commented May 21, 2018 via email

@syl20bnr syl20bnr merged commit 551ed9c into syl20bnr:develop May 21, 2018
@syl20bnr
Copy link
Owner

Nice work 👍
Thank you !
Cherry-picked into develop branch, you can safely delete your branch.

@athersharif athersharif deleted the patch-1 branch May 21, 2018 17:43
@aaronjensen
Copy link
Contributor

Until 26.1 is released (which should be soon) this change will encourage people to install 25.3 which lacks the vfork patch which means significantly slower magit. It's too bad, but hopefully 26.1 will be out soon.

@d12frosted
Copy link
Collaborator

d12frosted commented May 25, 2018

Hey folks,

Sorry I totally missed this topic.

On one hand I am all for mentioning different options (like the PR does, kudos!). On the other hand I don't think that it should be bloated as it increases the funnel to get to the Spacemacs. If you are new to Emacs ecosystem - it's impossible to make a decision. You just install whatever looks easier to install.

But that's just my two cents 😸

As for cask issue (d12frosted/homebrew-emacs-plus#41) I haven't invested time in solving it. But I will hopefully do it pretty soon™ (in case someone is interesting is solving this issue sooner than later - just let me know).

As for installation instructions of emacs-plus - I think it makes a huge sense to add a note about ln instead of linkapps (like emacs-mac does).

Update Regarding cask - I am not promising that I will provide cask builds, but I'll definitely take a look.

@dijonkitchen
Copy link
Contributor

When is the develop branch going to be merged into master for these new Readme changes? It's pretty confusing for a new user unless you've looked across a few issues.

@tkothe
Copy link

tkothe commented Dec 11, 2018

Just checking whether this will be merged to master soon as I also just came across the issue of the lack of the brew linkapps command. Cheers!

@cjoshmartin
Copy link

Brew suggested that I should run brew link emacs-plus and it work it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants