Commit Graph

463 Commits

Author SHA1 Message Date
d12frosted b7362c18ae
improve note about insecure connection in readme
After 8a7a4ce
2016-06-17 09:25:37 +03:00
Roy Xue 8a7a4ce1c3
Improve Installation Guide in README 2016-06-17 09:22:33 +03:00
Marc Ignacio 77cc71cac3 Update README.md
Just noticed while I was installing this new shiny toy. Looks awesome!
2016-05-11 20:47:14 -04:00
syl20bnr b16eb68b7e doc: add more info about emacs-plus tap 2016-04-04 22:14:57 -04:00
d12frosted 2919d57145 ask to install emacs on os x using emacs-plus tap 2016-04-04 21:53:40 -04:00
syl20bnr 5aecbe2427 README.md: add waffle throughput graph 2016-03-31 00:15:24 -04:00
d12frosted fa5e66c799 change OS X installation instructions
So not it's recommended to install GNU emacs instead of emacs-mac as
discussed in #4955.
2016-03-30 18:31:19 -04:00
Xue Fuqiao 156508f92a Change a link from the GitHub file to spacemacs.org in README.md 2016-03-30 18:19:38 -04:00
syl20bnr 744cd0f9b7 README.md: fix links to spacemacs.org
Links to documentation sections can easily break since they are
indexed by their order (i.e. #orgheadline8)
2016-03-19 22:01:09 -04:00
syl20bnr c9bcb65fa1 README.md: change links to spacemacs.org 2016-03-19 21:53:05 -04:00
JAremko 6b2d50e36d set spacemacs badge url to spacemacs.org 2016-03-10 23:13:19 -05:00
syl20bnr 9f8409392a testing new organization of badges 2016-03-04 11:07:27 -05:00
Making GitHub Delicious ffdf0a8245 add waffle.io badge 2016-03-04 10:05:07 -05:00
syl20bnr 3a83eda5d6 Rephrase note about Ubuntu package repos 2016-02-16 23:10:30 -05:00
Robert O'Connor cec296e60c README: update docs for getting emacs on Ubuntu
The version is 24.3 and is not well supported anymore.

Closes #5071
2016-02-16 23:07:30 -05:00
Robert O'Connor 7f92bf3f76 README: remove trailing whitespace 2016-02-16 23:05:28 -05:00
Robert O'Connor 292e029935 Add zenhub badge to README 2016-02-14 23:06:43 -05:00
Balaji Sivaraman e19abfc559 Fix/delete dead references to HOWTOs.org file 2016-01-31 23:04:47 -05:00
syl20bnr 82475814c1 Add alternative installation from FAQ to README 2016-01-31 20:43:08 -05:00
Eoin Houlihan 97a9487d84 Add Bountysource to "Supporting" in the README 2016-01-11 21:45:01 -05:00
syl20bnr 3150106d64 Shorten Quotes about Spacemacs to Quotes 2016-01-11 01:13:09 -05:00
Fabien Dubosson 60d38ffdd2 Add "Quotes about Spacemacs" in README 2016-01-11 01:13:09 -05:00
Eivind Fonn c4ca751d82 Hint about deleting elpa dir in README
[ci skip]
2016-01-11 01:13:09 -05:00
Fabien Dubosson 4be19eff93 Update the TOC of the README.md 2016-01-10 18:43:13 +01:00
syl20bnr cddf18ff1e Update install layer section in REAMDE.org files 2016-01-06 00:21:55 -05:00
Matt Baker 4a3de3be0a Clarify README regarding the installation of the os x layer 2016-01-05 21:40:00 -05:00
syl20bnr 74689e0c22 Add documentation in README.md and FAQ for --insecure
Should fix #4375
2016-01-05 01:16:29 -05:00
Robert O'Connor 3c1982ddb8 Note about updating packages after updates 2016-01-05 00:43:33 -05:00
Xue Fuqiao ac50f8f28a Change [Update] to [Update Packages] in README.md
Since Spacemacs 0.105.0, the [Update] button has been changed to [Update Packages].
2016-01-05 00:40:41 -05:00
Fabien Dubosson 6cb7399cac Change `SPC f e h` to `SPC h SPC` for helm-spacemacs default binding
This make `SPC h SPC` as default binding for accessing `helm-spacemacs`,
by either A) changing all the documentation; and B) adding a deprecation
message for `SPC f e h`.

The deprecation use a warning, because if a message is used it's hidden
directly when the helm buffer is shown, making it nearly unnoticeable
for the user.
2016-01-03 22:23:12 -05:00
Fabien Dubosson 92d25d55eb Fix another typo in README.md 2016-01-03 14:38:12 +01:00
Titouan Vervack d6b128b2bb Fix some typos in README.md 2016-01-03 14:36:10 +01:00
Fabien Dubosson 315528c89f Refactor CONTRIBUTING documentations
This commit merge the `CONTRIBUTING.md` and `doc/CONTRIBUTE.org` file
into a new `CONTRIBUTING.org` file. It also refactors the content to be
more organized and make its navigation more goal-oriented.

Github displays a link to the `CONTRIBUTING.*` file when people are
opening new issues or proposing new PRs. This file is important because
it is the entry-point to contributions guidelines for most of the users.
The current setup is non-optimal, even broken, as it adds a level of
indirection, and points to a contributing file that has broken
links (due to the new documentation format). The possible drawback of
the proposed solution is that I'm not sure if it is possible to include
it into the new online documentation as it is not in `doc/` folder.

The other possibility is to keep a small `CONTRIBUTING.md` file, as it
is now, pointing to the new documentation system (once online), but I'm
preferring the proposed solution for the following reasons:

- People that are willing to contribute will probably open Github
  first (for forking, creating PR, etc), not the online documentation.

- It has one level of indirection less when people click on the
  guidelines guide from a new issue/PR.

- `CONTRIBUTING.*` is by convention a special kind of file on github, so
  it's valid reason to break the rule and not having it in the `doc/`
  folder.
2015-12-11 01:09:09 -05:00
Fabien Dubosson 0102853145 Update the README for Emacs 25 being buggy
As suggested in #4000, make clear that Emacs 25 is only partially
working.
2015-12-07 15:39:30 +01:00
dotneter 011a738e88 Communities' links 2015-12-04 00:08:00 -05:00
syl20bnr 47f3ad3ac8 README.md: minor cosmetic change 2015-12-01 00:49:31 -05:00
Immortalin 9d326456a5 Update update instructions
This fixes #1837
2015-12-01 00:48:08 -05:00
syl20bnr eff69993b1 README: minor reformat to respect the 80th column 2015-11-29 22:35:48 -05:00
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