Installation guide is out of date - refers only to Emacs 27

twirley commented 8 months ago

I confirm that...

[X] I have searched the issue tracker, documentation, FAQ, Discourse, and Google, in case this issue has already been reported/resolved.
[X] I have read "How to Debug Issues", and will use it to provide as much information about this issue as possible.
[X] The issue can be reproduced on the latest available commit of Doom.
[X] The issue can be reproduced on a stable release of Emacs, such as 27, 28, or 29. (Unstable versions end in .50, .60, or .9x)

Expected behavior

I am new to Doom Emacs and are in need of an guide on how to install Doom Emacs, preferably on Linux and MacOS. The getting started page or the README.md should have the most current informations on how to install Doom Emacs

Current behavior

The getting started page was updated last in 2021 and shows (I think) not current suggestions. the README.md page is more current - but it lakes information on where to find an guide on how to install the most current version of Emacs. The provided links are leading to an page where it suggests ways to install Emacs 28.

Many blogposts show different ways on how to install Doom Emacs - but there should be an official current guide? And maybe an suggestion on which Emacs version I should choose, if start fresh - I guess the current one, in this case 29?

Any link or hint for an current guide on how to install Doom Emacs would be greatly appreciated

Steps to reproduce

Go to https://github.com/doomemacs/doomemacs/blob/master/docs/getting_started.org and try to figure out from the information provided, how to install the current version of Emacs... And what version you should choose.

System Information

I couldn't install it yet, still looking for an current guide on how to do so....

twirley commented 8 months ago

Questions I found, that might be addressed in an getting started guide:

Make it clear, that Emacs has to be installed first and that there are three versions supported (27, 28, 29) Maybe even give a recommendation, like you did in the README.md
Make it clear, what the difference is between Hlissners github or the this doomemacs github repository, and which one should be used
Provide a link for a guide on how to install Emacs - maybe even on how to do that with native compilation, since doom doctor suggests it is important on some machines? The link in the more current README.md suggests 29 with native compilation. The guide it links to is this https://www.emacswiki.org/emacs/GccEmacs, but this link seems out of date as well since it shows how to install 28 with native compilation After some search I found more suggestions, like this page https://www.gnu.org/software/emacs/manual/html_node/efaq/Installing-Emacs.html. - but here is missing how to add native compilation Or from an blog post I got the suggestion to simply use sudo apt install emacs-gtk ripgrep git So I still don't know how to install the suggested version of Emacs with native compliation or where to find an guide on how to do so...
As I understand, there also should be this command used after installing emacs, to install the nerd fonts? emacs --batch -f nerd-icons-install-fonts Maybe this aspect could be added to the guide as well

hlissner commented 8 months ago

I am aware of all these issues and more with our outdated docs and am already working on it.

tamasgal commented 8 months ago

Just a comment: by the time of writing, the following Emacs port (v29.1) works flawlessly on macOS Sonoma:

brew tap railwaycat/emacsmacport
brew install emacs-mac --with-modules
ln -s /usr/local/opt/emacs-mac/Emacs.app /Applications/Emacs.app

I used brew install emacs-plus@29 --with-modern-doom3-icon before but it had some glitches when I upgraded to macOS Sonoma. Eventually the above port was the one which worked "out of the box".

A workaround however is needed to fix the "large title bar on macOS Sonoma" issue (see #7532) by placing the following code into config.el:

;; workaround for large title bar on macOS Sonoma
;; see https://github.com/doomemacs/doomemacs/issues/7532
(add-hook 'doom-after-init-hook (lambda () (tool-bar-mode 1) (tool-bar-mode 0)))

doomemacs / doomemacs