Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

nikolaiam
Copy link
Contributor

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!

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.
Copy link
Contributor

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.

@nikolaiam nikolaiam force-pushed the add-beginners-tutorial branch 2 times, most recently from ae18bee to 6d6e4e2 Compare May 19, 2016 05:50
@bmag
Copy link
Collaborator

bmag commented May 26, 2016

I like it. A few notes:

  • key shortcuts look nicer if you format them. e.g. ~SPC b b~ instead of SPC b b
  • absolute beginners don't know how to read Emacs key notation: SPC is space, C- is Ctrl, M- is Alt (or something else on Mac?), s- is Super, etc. C-c a means "Ctrl+c, then a", C-c C-a means "Ctrl+c, then Ctrl+a", etc. I couldn't find a good external resource that explains it, although I'm sure I've read one in the past.

** 3. Install Spacemacs
Open a terminal or command prompt, paste the following code to it:

git clone https://github.com/syl20bnr/spacemacs ~/.emacs.d
Copy link
Collaborator

@d12frosted d12frosted May 26, 2016

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.

Copy link
Collaborator

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 ~/

Copy link
Collaborator

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 :)

@d12frosted
Copy link
Collaborator

General advice - don't forget to wrap inline code and key bindings with tilde like ~code~. Also you should wrap code blocks with following:

#+BEGIN_SRC lang-name

#+END_SRC

It renders beautifully in org-mode and on GitHub Pages.

@d12frosted
Copy link
Collaborator

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
Copy link
Collaborator

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. 💯

@nikolaiam nikolaiam force-pushed the add-beginners-tutorial branch 2 times, most recently from 8f2a9fe to 0088f37 Compare May 28, 2016 13:23
@nikolaiam
Copy link
Contributor Author

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
@syl20bnr
Copy link
Owner

This is my fault, will fix this evening.

@syl20bnr syl20bnr added Merged and removed Merging... labels Nov 7, 2016
@syl20bnr syl20bnr self-assigned this Nov 7, 2016
@syl20bnr
Copy link
Owner

syl20bnr commented Nov 7, 2016

Thank you ! 👍
Cherry-picked into develop branch, you can safely delete your branch.

@syl20bnr syl20bnr closed this Nov 7, 2016
@syl20bnr syl20bnr removed the Merged label Nov 7, 2016
@nikolaiam nikolaiam deleted the add-beginners-tutorial branch November 8, 2016 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants