Commit graph

425 commits

Author SHA1 Message Date
Jonathan Ragan-Kelley d6196279e7 Note in README: customize dotfile *after* install
Prefix the "It is also recommended…" part of the Mac installation prerequisites with a note that this should be done *after* the basic install process.

This tripped me up and prevented initial installation. (The more detailed instructions and warnings added to Install since the current master will also help.)
2015-11-29 11:56:19 +01:00
Robert O'Connor 42d1135438 Fix the badge - the github CDN cache is stale. 2015-11-25 00:33:00 +01:00
Kay Rhodes 7a8487cd68 README update to prevent homebrew mistakes
Homebrew users expect a homebrew install to get them everything they need.
Because of this I've added a note indicating that you *also* need to do
the git clone mentioned at the top of the file.
2015-11-24 23:19:38 +01:00
nashamri f726601c02 Fix rawgit badge cache 2015-11-15 12:27:02 +01:00
Robert O'Connor 7f31eb4bf7 Since this is made with spacemacs, add our badge. 2015-11-14 00:35:59 -05:00
nashamri b4b60917b8 Spacemacs badge usage 2015-11-14 00:35:33 -05:00
Boris 5faf93ef92 be explicit in installation notes about ~/.emacs 2015-11-13 13:42:41 +01:00
Swaroop C H 272fb1dbd7 [readme] No need for git clone --recursive
All submodules were removed in 0.104.0 release:
https://github.com/syl20bnr/spacemacs/blob/develop/CHANGELOG.org#01040-20150928
2015-11-09 18:58:20 +01:00
Muneeb Shaikh 38e9fc050a Make explicit note about emacs-mac-port multi-tty GUI
Quite a lot of questions in Gitter about this.
2015-11-04 20:21:06 +01:00
d12frosted ab9c8c020d ask user to backup ~/.emacs as well 2015-11-02 00:44:56 -05:00
masukomi baff41545a Fix brew tap url in README 2015-10-19 21:58:10 -04:00
syl20bnr a3aba4ebe7 Revert "corrected brew tap url in README"
This reverts commit 6aa5dd3ce8.
2015-10-19 01:18:18 -04:00
masukomi 6aa5dd3ce8 corrected brew tap url in README 2015-10-19 00:25:59 -04:00
justbur bfd360440f doc: Be consistent with ref to Spacemacs
Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as
a convention
2015-10-14 00:32:09 -04:00
Steve Purcell e53aa90bea Better copywriting in Introduction section of README 2015-10-10 23:56:26 -04:00
Eivind Fonn 9e794df0f8 readme: fix powerline update image 2015-10-02 19:37:16 +02:00
Xue Fuqiao aa2c416f95 Update links to FAQ.org 2015-10-02 19:30:33 +02:00
syl20bnr cd8e7e1942 readme: attempt to fix formating 2015-09-29 21:42:40 -04:00
Kartik Singhal 22eb9b6032 Update path to osx README 2015-09-28 23:31:37 -04:00
Robert O'Connor 9f3b249e27 Fix README.md blunder introduced in #3138 2015-09-28 02:36:11 -04:00
syl20bnr e6aab8703d readme: update screenshot 2015-09-28 01:42:55 -04:00
syl20bnr f29a94d15c readme: add a paragraph on how to revert to a specific version 2015-09-28 00:26:42 -04:00
Robert O'Connor ca102d2df3 Add contribution guidelines for GH to show.
We still link to the other doc/CONTRIBUTION.org.

The verbiage is pretty heavily based off of the Rails
Contribution Guidelines.

Fixes #3135
2015-09-27 22:17:25 -04:00
catern 7d45962abd Warn Linux users away from the "xemacs" package
XEmacs is packaged in many Linux distributions as "xemacs". Some may assume that "xemacs" and "emacs" have the same relationship as "gvim" and "vim", when in reality both packages have graphical support. Since I just had to correct this misunderstanding in someone, let's put it in the README to avoid it in the future.
2015-09-27 21:05:09 -04:00
person808 c5e4679234 Grammar fixes for README. 2015-09-23 23:31:40 -04:00
syl20bnr e06bf1fcd6 Typo in README.md 2015-09-22 23:28:58 -04:00
syl20bnr 2ab7a2a60f Rewrite README.md to make it lighter
And move some parts to QUICK_START.org and FAQ.org
2015-09-22 23:26:12 -04:00
Vivien Moreau 44d9b0c1d9 Remove a duplicate of the ToC in the project's README 2015-09-08 18:47:34 +02:00
Morton Fox ce80220f30 Fix link to git layer. 2015-08-29 08:51:30 +02:00
justbur b29f1a5af9 Swap = for backquotes in readme 2015-08-28 11:49:54 +02:00
justbur d1bb779340 Update docs for which-key 2015-08-26 22:58:24 -04:00
Robert O'Connor 787b1dff60 fix the docs to reflect submodules are no longer used 2015-08-05 00:28:10 -04:00
Sridhar Ratnakumar b4d1d3deb7 Hint at cask for fast binary install
Instaling via cask takes a few seconds as it fetches pre-built binary, also managed by the railwaycat repo.
2015-08-02 17:44:20 -04:00
Swaroop C H 0789b68321 Update docs on describe-system-info 2015-08-02 17:42:59 -04:00
Swaroop C H 6798c5be85 Add "system-info" fn for IRC support
I have seen many "I have a problem" discussions in the Gitter chat which
starts with a barrage of questions "Which OS? Which Emacs version?",
etc., so I thought it may be useful to have one function that will
generate the info to be copy-pasted into the Gitter chat and hence both
the user and others helping in the Gitter chat can jump directly to
solving the problem instead of the support volley to figure out the
setup.

Example output:

ELISP> (spacemacs/system-info)
"OS: darwin Emacs: 24.5.1 Spacemacs: 0.103.0 Spacemacs branch: develop
Layers: ((auto-completion :variables auto-completion-enable-help-tooltip
t) better-defaults emacs-lisp git markdown org (shell :variables
shell-default-height 30 shell-default-position (quote bottom))
syntax-checking version-control c-c++ clojure dash github html osx
python semantic sql)"

References:

From
https://github.com/syl20bnr/spacemacs/issues/2033#issuecomment-113861451 :

> Also what is your emacs version and OS ?

From
https://github.com/syl20bnr/spacemacs/issues/2042#issuecomment-113861501 :

> What's your Emacs version ? I presume it comes from the semantic
layer, can you test without the semantic layer ?
2015-08-01 00:26:40 -04:00
syl20bnr 6a1365d6cd README: add brief mention about .spacemacs.d direcotry
TODO: complete doc in DOCUMENTATION.org
2015-07-23 22:38:09 -04:00
MadAnd 7f3c57ec9c fix: broken link in README 2015-07-04 18:46:53 -04:00
Xue Fuqiao 7a9d720949 Fix the link for pt in README.md. 2015-07-04 18:43:54 -04:00
Christopher Corley 68e3d42f9d Fixes links to other documents (.md => .org) 2015-07-04 18:43:31 -04:00
Robert O'Connor 739a50e031 fix broken links in README in root of the repo 2015-06-22 22:50:44 -04:00
syl20bnr 8a925e9178 Revert back helm-descbinds on SPC ?
SPC / is now search in project with default input
2015-06-19 22:31:29 -04:00
Oliver Mooney 24d03a9346 Update documentation for emacs-mac 2015-06-11 23:23:09 -04:00
syl20bnr b3fa604237 Split git layer into git and github layers 2015-06-09 22:42:11 -04:00
syl20bnr 2aaf3ea6dd README: mention the major-specific leader key 2015-06-02 22:29:54 -04:00
syl20bnr 9a6c6ca193 README: add instructions for windows users
Fixes #1754
2015-06-02 22:29:08 -04:00
Tristan Hume 1ac8c2689a Update docs for renaming. 2015-05-25 00:50:43 -04:00
syl20bnr 1400d5ceae Edit troubleshooting info for windows users. 2015-05-18 22:44:05 -04:00
Andrea 6b3c7133cf Add some troubleshouting info for windows users 2015-05-18 22:40:40 -04:00
syl20bnr 5c84cc9ff2 Add FAQ about emacs -q and after-init-hook
fixes #844
2015-05-10 00:08:33 -04:00
Swaroop C H 28103945f0 Mention IRC option for Gitter Chat in README
I have seen requests in the Gitter Chat such as:

> @CJD14: there wouldn't happen to be an IRC channel for spacemacs, would there?
2015-04-27 23:58:02 -04:00
Camille TJHOA d3e14419f4 Remove conflicting 'dotfile' entry 2015-04-27 23:30:36 -04:00
Devagamster 5ad18fc5e2 Fix links
I wrote the link markup wrong in the windows image support section. This should fix it.
2015-04-26 00:42:48 -04:00
Carl Lange 2adce44bc9 Changed emacs-mac-port link
Changed it from the now-un-updated mirror to the correct homebrew package.
2015-04-22 01:06:58 -04:00
person808 86dae6aba7 Docs: Change company-mode to auto-completion.
Removes one potential pitfall for new users.
2015-04-19 00:40:14 -04:00
NGK Sternhagen 1c34e9f453 change wording to avoid grammar issue
"fonts ... looks" is a bit awkward, this wording avoids the
subject/verb agreement issues.
2015-04-19 00:39:19 -04:00
syl20bnr 5dd5c4670d Move image support instruction for windows to FAQ 2015-04-19 00:38:07 -04:00
Devagamster 5019adb20f Image support instructions on windows
I noticed that the xkcd layer wasn't working on my windows box. After a little digging I found out that I was using the default download from the gnu emacs site which does not include the image support dlls. Hopefully this change will help people in the future in my same situation.
2015-04-19 00:32:43 -04:00
zimbatm 51280cf4d8 Access github over SSL
Changes all links to github from http:// to https://
2015-04-19 00:27:48 -04:00
syl20bnr fdd4e944ef Reload dotfile and layer anywhere with SPC f e R
Replace `SPC m c c` and `C-c C-c` in the dotfile

Resolve #1210
2015-04-18 23:40:24 -04:00
person808 839c3732b0 Fix broken link in README. 2015-04-11 23:56:19 -04:00
syl20bnr 3b308ab608 Add FAQ about spacemacs pronunciation 2015-04-11 23:09:20 -04:00
syl20bnr 625cb46a59 Fix missing link in README 2015-04-08 21:51:54 -04:00
syl20bnr 8ae66d6950 Add license to README 2015-04-07 22:51:21 -04:00
syl20bnr 998eba7782 Add Buy a Drink button 2015-04-07 22:01:55 -04:00
syl20bnr 65e86b3354 Add HOWTOs.md 2015-04-07 21:25:06 -04:00
syl20bnr ee2aa24bec Integrate dotfile wizard at startup 2015-03-30 23:17:29 -04:00
Tu Do c278b58a0b Ask user editing style when creating .spacemacs file 2015-03-30 19:18:36 -04:00
syl20bnr 58c847d76a Center title links in the README 2015-03-29 01:17:04 -04:00
syl20bnr a8b4a6397a Further edition of README to adapt it to the two styles 2015-03-29 00:51:50 -04:00
syl20bnr 1ddc340a72 Edit README introduction 2015-03-29 00:45:02 -04:00
syl20bnr 75bcded008 New README introduction, adapt the readme to the new editing styles 2015-03-29 00:34:57 -04:00
Ivan Malison 79a0b4a362 who -> whom in README.md 2015-03-26 12:40:09 -04:00
syl20bnr 4d0f391a8e Add link to Christoph Paulik tutorial to use the spacemacs icon 2015-03-21 20:05:35 -04:00
syl20bnr 5e4af5dc04 Update documentation to reflect the new startup behavior 2015-03-18 01:13:45 -04:00
syl20bnr 34d7cee6d0 Enable utf8 support for the new powerline in terminal.
Must use a patched font.
2015-03-13 22:07:53 -04:00
syl20bnr ef4d48a283 Add Spacemacs logo by Nasser Alshammari to the README 2015-03-12 23:50:50 -04:00
Jason Rose-Kuhrt fbf4be36cd Minor fixes/improvements to vocabularly, grammar, clarity 2015-03-11 00:03:32 -04:00
Devin Rhode 404e1c2254 A successful install should show "Loading...Ready! 2015-03-07 00:08:08 -05:00
syl20bnr b7a8c38fb4 Add documentation for dotfile changes resynchronization 2015-03-02 23:10:45 -05:00
Michael Sproul 35e239b226 Improve some grammar in the README. 2015-02-22 01:30:32 -05:00
m3hr 6f4a44df79 Fix LaTex typo/link in README
It was bothering me lol
2015-02-10 23:14:50 -05:00
syl20bnr 7d87c9cc6b Add doc for rollback 2015-02-04 00:44:03 -05:00
syl20bnr bfe5f520ae Remove package update procedure using paradox from the documenation 2015-02-03 02:06:20 -05:00
syl20bnr 23c2314247 Revert back #250
I cherry-picked it and played with it.
There is a major problem with this approach: all `after-init-hooks` will
be triggered right away because the hook is run before the end of the
alternate init
file ([source](https://groups.google.com/forum/#!topic/gnu.emacs.help/IrMz48PQykk))
. It leads to numerous errors, I fixed the spacemacs ones but obviously
I cannot fix the errors from packages. The remaining errors don't
prevent spacemacs from working but they give a very bad impression on
spacemacs quality with errors logs in `*Messages*`.

For those reasons I revert back this change as well as the documentation
I added.

https://github.com/syl20bnr/spacemacs/pull/520
2015-02-02 00:14:17 -05:00
syl20bnr e6d105b87e Add alternative setup instructions in README 2015-02-01 23:12:07 -05:00
syl20bnr 4d4dab1514 Update documentation for property :powerline-scale 2015-01-28 00:16:51 -05:00
syl20bnr 7a6d95d404 Add documentation for new dotspacemacs-default-variable 2015-01-26 23:22:20 -05:00
syl20bnr e0e2d71940 Minor format fix in README FAQ 2015-01-26 00:13:27 -05:00
syl20bnr 97c8c1c490 Remove absolute links pointing to master branch in README.md 2015-01-25 23:29:27 -05:00
syl20bnr 5ea31977f5 Extend dotspacemacs-configuration-variables with properties
First property implemented is `:variables`
Allow to set the layer variables directly where it is declared
2015-01-25 23:22:41 -05:00
Frederick F. Kautz IV 1d4ab99367 Fix README.md link to git documentation 2015-01-25 00:04:53 -05:00
syl20bnr 8582003292 Move badges 2015-01-14 21:50:12 -05:00
lazywithclass c5224a3319 Add Travis CI support for core tests #144
Added the badge to the README.md and created a travis config file.
2015-01-14 21:39:35 -05:00
Andrés Martano 5f8f3fa18a Fix a typo in README 2015-01-13 23:27:45 -05:00
syl20bnr a1fa06a230 New evil-lisp-state 2015-01-11 23:00:13 -05:00
syl20bnr 03943dd059 Mode-line indicator for new release 2015-01-08 00:34:23 -05:00
syl20bnr b34f63d94f Remove the emacs-live mention
Some users believed that Spacemacs uses the live packages
for its configuration.
2015-01-06 18:50:56 -05:00
syl20bnr b1a5354d1c Add a TOC to README 2015-01-06 18:50:20 -05:00
syl20bnr 6d79e83aaa Fix README headers level in Features section 2015-01-06 18:49:37 -05:00
syl20bnr 64c7ac6e69 Fixes #381 server directory unsafe on windows
Add this issue to the FAQ
Break the questions into categories: common, windows, os x
2015-01-06 18:48:13 -05:00