-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add beginners tutorial #6085
Add beginners tutorial #6085
Conversation
having different submenus associated with them, usually with a mnemonic for | ||
easier recall. The letter w is assigned for "windows": press it. A new menu | ||
opens with further options. We will write the character / (that is, shift and | ||
seven) to split the currently active window vertically into two. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is only true for certain keyboard layouts.
ae18bee
to
6d6e4e2
Compare
I like it. A few notes:
|
** 3. Install Spacemacs | ||
Open a terminal or command prompt, paste the following code to it: | ||
|
||
git clone https://github.com/syl20bnr/spacemacs ~/.emacs.d |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be wrapped in BEGIN_SRC
as:
#+BEGIN_SRC shell
$ git clone https://github.com/syl20bnr/spacemacs ~/.emacs.d
#+END_SRC
It will properly render this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think ~/.emacs.d
works in Windows (unless you use cygwin or similar). Easiest way I found to discover the real .emacs.d
path on windows is to open ~
in Dired: M-x dired ~/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I don't know how it works on Windows (never really used it oO).
My point was about document structure :)
General advice - don't forget to wrap inline code and key bindings with tilde like
It renders beautifully in |
Also, please read and follow these conventions about writing documentation. 😸 |
into Spacemacs. Because the spacebar is the most accessible key on the keyboard | ||
and is pressed by the strongest fingers (the thumbs), it is a natural choice for | ||
launching commands. You can think of it as the start menu of Spacemacs. | ||
** Buffers, windows and frames |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice to bring up this topic. 💯
8f2a9fe
to
0088f37
Compare
After the newest amendments the Travis CI build failed and I'm at a total loss why. Any suggestions on what the problem is? |
Amend suggested fixes: - Add chapter on key notation - Fix document structure according to conventions - Add note on emacs path on Windows - Expand on evil and emacs mode explanations - Expand on first startup procedure - Various typo fixes and clarifications
0088f37
to
8be0037
Compare
This is my fault, will fix this evening. |
Thank you ! 👍 |
Spacemacs has good documentation for the more computer-savvy, but
for non-programmers and those who have never heard of Emacs or Vim
before the process of installation and initial setup can be a bit
overwhelming, especially as a the information has to be collected from
multiple sources.
This detailed tutorial walks the user through the
setup process and shows the basic functionality of the program. It is
meant to serve as the one document one needs to get up-and-running with
Spacemacs.
Feedback is very welcome!