[doc] Fix wrong min emacs version and rewrite update instructions
This commit is contained in:
Maxi Wolff
parent
41ea2b2136
commit
0cbd48f0a5
44
README.md
44
README.md
|
|
@ -83,10 +83,10 @@ the [full installation instructions](#install) for other options.
|
|||
- [Modify spacemacs-start-directory variable](#modify-spacemacs-start-directory-variable)
|
||||
- [Spacemacs logo](#spacemacs-logo)
|
||||
- [Update](#update)
|
||||
- [Rolling update (on develop)](#rolling-update-on-develop)
|
||||
- [Automatic update (on master branch)](#automatic-update-on-master-branch)
|
||||
- [Manual update (on master branch)](#manual-update-on-master-branch)
|
||||
- [On develop branch](#on-develop-branch)
|
||||
- [Revert to a specific version](#revert-to-a-specific-version)
|
||||
- [Revert to a specific version (on master branch)](#revert-to-a-specific-version-on-master-branch)
|
||||
- [Quotes](#quotes)
|
||||
- [Contributions](#contributions)
|
||||
- [Communities](#communities)
|
||||
|
|
@ -152,7 +152,7 @@ to first install base Emacs and then download the Spacemacs extension files with
|
|||
Git.
|
||||
|
||||
## Emacs
|
||||
Spacemacs requires Emacs 25.1 or above. The development version of Emacs is not
|
||||
Spacemacs requires Emacs 27.1 or above. The development version of Emacs is not
|
||||
*officially* supported, but it should nevertheless be expected to work.
|
||||
|
||||
Some modes require third-party tools that you'll have to install via your
|
||||
|
|
@ -166,9 +166,8 @@ an old fork of Emacs. The X in its name is unrelated to X11.
|
|||
|
||||
Emacs has graphical support.
|
||||
|
||||
**Note:** The Ubuntu LTS 12.04 and 14.04 repositories only have Emacs version
|
||||
24.3 available. Version 25.1 or greater needs to be [built from source][build_source].
|
||||
This might also be true for other linux distributions.
|
||||
**Note:** Some linux distributions support only emacs versions older than 27.1.
|
||||
In this case you should [built from source][build_source] instead.
|
||||
|
||||
### macOS
|
||||
|
||||
|
|
@ -178,8 +177,6 @@ This might also be true for other linux distributions.
|
|||
|
||||
```
|
||||
brew tap d12frosted/emacs-plus
|
||||
# to install Emacs 26
|
||||
brew install emacs-plus
|
||||
# or to install Emacs 27
|
||||
brew install emacs-plus@27 --with-spacemacs-icon
|
||||
# or to install Emacs 28
|
||||
|
|
@ -468,9 +465,23 @@ For macOS users, you need to [download the .icns version of the logo][icon-repos
|
|||
then [change the logo on the Dock][icon-mac-instructions].
|
||||
|
||||
# Update
|
||||
Spacemacs shows a notification when a new version is available (only when you
|
||||
are on the default `master` branch). If you are on the `develop` branch then
|
||||
you'll have to update the Spacemacs repository manually.
|
||||
Spacemacs supports two different update schemes, the default is a rolling update scheme based
|
||||
on the latest version of packages available. This version can be found on the `develop` branch
|
||||
and is updated by a simple git pull.
|
||||
|
||||
The second depreciated one is a fixed version scheme which is based on a stable set
|
||||
of packages. This version can be found on the `master` branch and will show a notification when
|
||||
a new version is available. Be warned this has not been updated in a long time now so packages
|
||||
will be very old.
|
||||
|
||||
## Rolling update (on develop)
|
||||
1. Close Emacs and update the git repository:
|
||||
|
||||
```sh
|
||||
git pull --rebase
|
||||
```
|
||||
|
||||
2. Restart Emacs to complete the upgrade.
|
||||
|
||||
## Automatic update (on master branch)
|
||||
When a new version is available then a little arrow appears in the mode-line.
|
||||
|
|
@ -493,16 +504,7 @@ git fetch
|
|||
git reset --hard <tag version which you are updating to>
|
||||
```
|
||||
|
||||
## On develop branch
|
||||
1. Close Emacs and update the git repository:
|
||||
|
||||
```sh
|
||||
git pull --rebase
|
||||
```
|
||||
|
||||
2. Restart Emacs to complete the upgrade.
|
||||
|
||||
## Revert to a specific version
|
||||
## Revert to a specific version (on master branch)
|
||||
To revert to a specific version, just checkout the corresponding branch. For
|
||||
instance to revert to version `0.200`, type the following command:
|
||||
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@
|
|||
- [[#who-can-benefit-from-this][Who can benefit from this?]]
|
||||
- [[#update-and-rollback][Update and Rollback]]
|
||||
- [[#update-spacemacs-repository][Update Spacemacs repository]]
|
||||
- [[#automatic-updates][Automatic Updates]]
|
||||
- [[#updating-from-the-spacemacs-buffer][Updating from the Spacemacs Buffer]]
|
||||
- [[#updating-manually-with-git][Updating Manually with git]]
|
||||
- [[#updating-manually-with-git-for-develop][Updating Manually with git (for develop)]]
|
||||
- [[#automatic-updates-for-master][Automatic Updates (for master)]]
|
||||
- [[#updating-from-the-spacemacs-buffer-for-master][Updating from the Spacemacs Buffer (for master)]]
|
||||
- [[#update-packages][Update packages]]
|
||||
- [[#configuration-layers][Configuration layers]]
|
||||
- [[#purpose][Purpose]]
|
||||
|
|
@ -306,31 +306,35 @@ project.
|
|||
* Update and Rollback
|
||||
** Update Spacemacs repository
|
||||
There are several methods of updating the core files and layer information for
|
||||
Spacemacs. It is recommended to update the packages first; see the next section.
|
||||
Spacemacs. However afterwards you should always update all your packages; see the next section.
|
||||
|
||||
*** Automatic Updates
|
||||
Spacemacs supports two different update schemes, the default is a rolling update scheme based
|
||||
on the latest version of packages available. This version can be found on the =develop= branch
|
||||
and is updated by a simple git pull.
|
||||
|
||||
The second depreciated one is a fixed version scheme which is based on a stable set
|
||||
of packages. This version can be found on the =master= branch and will show a notification when
|
||||
a new version is available. Be warned this has not been updated in a long time now so packages
|
||||
will be very old.
|
||||
|
||||
*** Updating Manually with git (for develop)
|
||||
To update manually close Emacs and update the git repository:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
$ git pull --rebase
|
||||
#+END_SRC
|
||||
|
||||
*** Automatic Updates (for master)
|
||||
Spacemacs will automatically check for a new version periodically. When it
|
||||
detects that a new version is available an arrow will appear in the modeline.
|
||||
Click it to update Spacemacs. You must restart Emacs after updating.
|
||||
[[file:img/powerline-update.png]]
|
||||
/Update Button/
|
||||
|
||||
*Note*: If you use the =develop= branch of Spacemacs, automatic update is
|
||||
disabled---you have to update manually using git.
|
||||
|
||||
*** Updating from the Spacemacs Buffer
|
||||
*** Updating from the Spacemacs Buffer (for master)
|
||||
Use the button labeled "Update Spacemacs" in the Spacemacs buffer. You will be
|
||||
prompted for the version you would like to use.
|
||||
|
||||
*Note*: If you use the =develop= branch of Spacemacs, you cannot use this method.
|
||||
|
||||
*** Updating Manually with git
|
||||
To update manually close Emacs and update the git repository:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
$ git pull origin master
|
||||
#+END_SRC
|
||||
|
||||
*Note*: The master branch is considered to be immutable in the sense that you
|
||||
must not modify it by adding your own commit. If you do so you will break the
|
||||
automatic update of Spacemacs on the master branch. To fork Spacemacs code you
|
||||
|
|
|
|||
Loading…
Reference in New Issue