Skip to content

Commit b9124ad

Browse files
committed
Add getting_started guide
1 parent b714276 commit b9124ad

20 files changed

+573
-0
lines changed

getting-started/CLI_basics.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Command line cheaty-cheats
2+
3+
Working on the command line takes a little getting used to, but doesn't need too much practice to get comfortable with it.
4+
5+
|||
6+
| -- | -- |
7+
| `cd <folder>` | Change directory to `<folder>` |
8+
| `ls` (or `ls -all`) | Lists all files (including hidden files) |
9+
| `touch <file name>` | Create an empty file called `<file name>` |
10+
| `rm <file name>` | Remove the file called `<file name>` |
11+
| `code <file name>` | Open the named file in VS Code |
12+
13+
14+
Although you can use the sequence:
15+
16+
```bash
17+
touch <file name>
18+
code <file name>
19+
```
20+
21+
To create and then open an empty file, if you use `code <file name>` directly without creating the file first, VS code will create the file for you.
22+

getting-started/get_started.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Getting started as a contributor
2+
3+
This set of guides is intended for anyone who wants to contribute more substantial changes to documentation (or on a more regular basis) using the Ubuntu command line.
4+
5+
For quick corrections to a page, it's perfectly fine to use the GitHub web interface instead!
6+
7+
## Prerequisites
8+
9+
Before you start using this guide, you will need to set up [a GitHub account](https://github.com/), if you don't already have one.
10+
The GitHub documentation is rather good, if you get stuck or need any explanation of particular topics.
11+
12+
## Getting your environment set up
13+
14+
Where you start in this series will depend on whether you're using a Windows machine, or an Ubuntu one. If you're using Windows, start on Part 1. If you are running Ubuntu, or have a dual-boot system where one of your options is Ubuntu, feel free to skip Part 1 and go straight to Part 2.
15+
16+
1. [Getting started using Windows](start_with_WSL.md)
17+
2. [Install and configure git](install_git.md)
18+
3. [Working with git on the command line](using_git.md)
19+
20+
## Optional steps
21+
22+
1. [Set up Sphinx](setup_sphinx.md)
23+
This applies if you are working on a project that uses Sphinx to render the documentation.
24+
1. [Command line cheat sheet](CLI_basics.md)
25+
This reference will help remind you of the basic commands needed to work with files on the command line.
32.8 KB
Loading
28.4 KB
Loading
67.9 KB
Loading
30.8 KB
Loading
89.1 KB
Loading
18.5 KB
Loading
17.5 KB
Loading
52 KB
Loading

0 commit comments

Comments
 (0)