From 961ab8f74c5841f6cd1602c93f5a3748dbb14446 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Thu, 15 Mar 2018 14:50:59 +0530 Subject: [PATCH] [docs] Added descriptions of commands --- scripts/README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index 0d21079..2ed1ede 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -4,7 +4,7 @@ I made this script for my own convenience. Use at your own risk. Plenty of comme ## Install -Add this script to your `~/.bashrc` or `~/.zshrc`: +Automatically add this script to your `~/.bashrc` or `~/.zshrc`: ```bash mkdir ~/.mkr && curl https://raw.githubusercontent.com/MKRhere/wiki/master/scripts/mkr.sh -o ~/.mkr/mkr.sh @@ -14,6 +14,9 @@ echo "source ~/.mkr/mkr.sh" >> ~/.bashrc # or zsh echo "source ~/.mkr/mkr.sh" >> ~/.zshrc +# To start using right away without waiting for shell restart +source ~/.mkr/mkr.sh + # updating script mkr-update ``` @@ -21,19 +24,20 @@ mkr-update ## Commands - General - - `cls` + - `cls` : Clears screen + - `clip` : Copies to clipboard - apt - - `i ` - - `install ` - - `update` - - `purge ` - - `ar` / `autoremove` + - `i ` : Accepts prompts and installs packages + - `install ` : Installs packages without auto-accepting + - `update` : Equivalent to `apt-get update` + - `purge ` : Removes packages + - `ar` / `autoremove` : Equivalent to `apt autoremove` - Directories - - `mk ` - - `rmd [dir]` + - `mk ` : Makes dir and changes into it + - `rmd [dir]` : Removes current directory and moves up OR removes directory by given name - git - - `commit ` - - `push [remote branch]` + - `commit ` : Adds all untracked files and commits them + - `push [remote branch]` : Adds all untracked files, commits and pushes them - systemctl - `status ` - `start `