Skip to content

Documentation #34

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.

Sign up for GitHub

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

Open
varamezova wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Documentation #34

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71c5fb6
This docu file would help the newbies to understand some stuff.
varamezova Jul 14, 2022
06e2382
Added some helpful commands
varamezova Jul 14, 2022
95e59e8
Merge branch 'main' into documentation
varamezova Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion Documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,44 @@
## Documentation
## Documentation - WIP

* [Terminal Commands](#terminal-commands)
* [Git Commands](#git-commands)
* [Glossary](#glossary)

### Terminal Commands
- `mkdir DirectoryName` - creates a new directory
- `cd DirectoryName` - goes to the wished directory
- `touch Demo.rb` - creates an empty file
- `echo "Some text" >> Filename.extension` - creates a file with some text in it
- `cat Filename` - shows what’s inside the file
- `open Filename` - opens the file from Terminal with the corresponding program/editor to edit the contents as you normally would
- `ls` - lists everything in the current folder except 'dotfiles'/hidden files (e. g. .gitignore)
- `ls -a` - lists verything (including the hidden files)
- `cd ..` - moves up to the parent directory
Copy link
Owner

@Garllon Garllon Feb 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For ls -la and cd .. maybe it is better to create a sub header and describe it. cd .. is the same as cd DirectoryName.

Sorry for the super late answer.



### Git Commands
chrome-extension://efaidnbmnnnibpcajpcglclefindmkaj/https://www.badfv.de/files/Dokumente/tower_cheatsheet_dark_DE.pdf
- `git init` - creates a new local repo
- `git status`
- `git add <Filename.extension>` - adds a single file
- `git add .` - adds all files in the directory
- `git commit` - you can enter your message on an additional screen
- `git commit -m "some message"` - you can enter your message directly
- `git branch` - which branches I have in the repo
- `git checkout -b <branch_name>` - creates a new local branch and goes to it
- `git branch <branch_name>` - creates a new local branch
- `git branch -d <branch_name>` - deletes a local branch
- `git checkout <branch_name>` - goes to the wished branch
- `git branch -M <new branch name>` - renames your head branch ("head" = my current position)
- `git remote add origin <URL of your Git repo on GitHub.com>` - connects your GutHub repo with your computer
- `git pull`
- `git push`
- `git push <remote> <local branch>`
- `git remote -v` - lists all remote repos
- `git reset`
- `git reset --hard HEAD` - discards all local changes in the working copy
- `git log` - shows all local commits


### Glossary
* Commit
Expand All @@ -16,3 +48,5 @@


to be continued...

https://docs.google.com/document/d/1aSrEIcgZAemE_6Y6-_l2hheXvgzF3bCvQAbW_dlpifM/edit