philosophy | goals | for whom? | screenshots | documentation | contribute | achievements | FAQ

`. Then you can clone Spacemacs in this directory. Sometimes you'll get the following error when you first start Emacs: ``` The directory ~/.emacs.d/server is unsafe ``` To fix it change the owner of the directory `~/.emacs.d/server`: - from Properties select the Tab “Security”, - select the button “Advanced”, - select the Tab “Owner” - change the owner to your account name Source: [Stackoverflow][so-server-unsafe] For efficient searches we recommend to install `pt` ([the platinum searcher][]). `pt` version 1.7.7 or higher is required. # Install 1. If you have an existing Emacs configuration, back it up first: ```sh cd ~ mv .emacs.d .emacs.d.bak mv .emacs .emacs.bak ``` Don't forget to backup and *remove* `~/.emacs` file otherwise Spacemacs **WILL NOT** load since that file prevents Emacs from loading the proper initialization file. 2. Clone the repository: ```sh git clone https://github.com/syl20bnr/spacemacs ~/.emacs.d ``` `master` is the stable branch and it is _immutable_, **DO NOT** make any modification to it or you will break the update mechanism. If you want to fork Spacemacs safely use the `develop` branch where you handle the update manually. 3. Launch Emacs. Spacemacs will automatically install the packages it requires. If you get an error regarding package downloads then you may try to disable the HTTPS protocol by starting Emacs with ```sh emacs --insecure ``` You may wish to clear out your `.emacs.d/elpa` directory before doing this, so that any corrupted packages you may have downloaded will be reinstalled. 4. Restart Emacs to complete the installation. If the mode-line turns red then be sure to visit the [troubleshooting][troubleshoot] guide and consult the [FAQ][FAQ.org]. ## Spacemacs logo If you are using Ubuntu and Unity then you can add the Spacemacs logo by following the instructions [here][cpaulik-unity-icon]. If you're on a mac follow [these instructions][icon-mac-instructions]. You can find an .icns version of the logo by [Nasser Alshammari](http://www.nass3r.com) in [his repository][icon-repository]. # Update Spacemacs has a built-in notification of a new version when you are on the `master` branch. If you are on the `develop` branch then you'll have to update Spacemacs manually by updating your repository. ## Automatic update (on master branch) When a new version is available a little arrow appears in the mode-line. Its color depends on the number of versions available since your last update. Green means that your current version is recent, orange and red mean that your current version is older.  Click on the arrow to update Spacemacs to the last version. ## Manual update (on master branch) (Remove the angle brackets when typing the lines below into your shell.) ```sh git fetch git reset --hard ``` ## On develop branch 1. Update Emacs packages by clicking (press `RET`) on the `[Update Packages]` link of the starting page. 2. Close Emacs and update the git repository: ```sh git pull --rebase ``` 3. Restart Emacs to complete the upgrade. ## Revert to a specific version To revert to a specific version you just have to checkout the corresponding branch, for instance to revert to the last `0.103`: ```sh git checkout origin/release-0.103 ``` **After you update, either manually, or automatically, you are advised to update your packages by clicking the `[Update Packages]` button on the Spacemacs Home Buffer.** # Quotes [Quote][quote01] by [ashnur](https://github.com/ashnur): «I feel that spacemacs is an aircraft carrier and I am playing table tennis on the deck as a freerider.» # Contributions Spacemacs is a community-driven project, it needs _you_ to keep it up to date and propose useful and complete configuration! Before contributing be sure to consult the [contribution guidelines][CONTRIBUTING.org] and [conventions][CONVENTIONS.org]. # Communities - [Gitter Chat] - [Stack Exchange] - [Reddit] # License The license is GPLv3 for all parts specific to Spacemacs, this includes: - the initialization and core files - all the layer files - the documentation For the packages shipped in this repository you can refer to the files header. [Spacemacs logo][] by [Nasser Alshammari][] released under a Creative Commons license. # Supporting Spacemacs The best way to support Spacemacs is to contribute to it either by reporting bugs, helping the community on the [Gitter Chat][] or sending pull requests. If you want to show your support financially you can contribute to [Bountysource][] or buy a drink for the maintainer by clicking on the [Paypal badge](#top). If you used spacemacs in a project and you want to show that fact, you can use the spacemacs badge: [](http://github.com/syl20bnr/spacemacs) - For Markdown: ``` [](http://github.com/syl20bnr/spacemacs) ``` - For HTML: ``` ``` - For Org-mode: ``` [[https://github.com/syl20bnr/spacemacs][file:https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg]] ``` Thank you! [Twitter]: http://i.imgur.com/tXSoThF.png [CONTRIBUTING.org]: CONTRIBUTING.org [CONVENTIONS.org]: doc/CONVENTIONS.org [DOCUMENTATION.org]: doc/DOCUMENTATION.org [QUICK_START.org]: doc/QUICK_START.org [FAQ.org]: doc/FAQ.org [HOWTOs.org]: doc/HOWTOs.org [VIMUSERS.org]: doc/VIMUSERS.org [dotfile]: doc/DOCUMENTATION.org#dotfile-configuration [troubleshoot]: doc/DOCUMENTATION.org#troubleshoot [osx layer]: layers/osx/README.org [Gitter Chat]: https://gitter.im/syl20bnr/spacemacs [Gitter Chat IRC server]: https://irc.gitter.im/ [emacs-mac-port]: https://github.com/railwaycat/homebrew-emacsmacport [emacs-mac-port-server]: https://github.com/railwaycat/emacs-mac-port/blob/master/README-mac#L210-L213 [emacs-for-windows]: http://emacsbinw64.sourceforge.net/ [the platinum searcher]: https://github.com/monochromegane/the_platinum_searcher [so-server-unsafe]: http://stackoverflow.com/questions/885793/emacs-error-when-calling-server-start [Spacemacs logo]: https://github.com/nashamri/spacemacs-logo [Nasser Alshammari]: https://github.com/nashamri [cpaulik-unity-icon]: http://splendidabacus.com/posts/2015/03/spacemacs-unity-icon/ [icon-mac-instructions]: http://www.idownloadblog.com/2014/07/16/how-to-change-app-icon-mac/ [icon-repository]: https://github.com/nashamri/spacemacs-logo [Stack Exchange]: http://emacs.stackexchange.com/questions/tagged/spacemacs [Reddit]: https://www.reddit.com/r/spacemacs [quote01]: https://gitter.im/syl20bnr/spacemacs?at=568e627a0cdaaa62045a7df6 [Bountysource]: https://salt.bountysource.com/teams/spacemacs