Update README
This commit is contained in:
parent
c42ffc0edc
commit
99813ad252
12
README.md
12
README.md
@ -15,6 +15,18 @@ All snippets will be listed below with the directories in the master branch. If
|
||||
https://github.com/shaunrd0/...
|
||||
|
||||
klips/
|
||||
├──── ansible/ (Ansible roles, playbooks)
|
||||
│ │
|
||||
│ ├── nginx.yml (Playbook example for using nginx role)
|
||||
│ │
|
||||
│ ├── hosts (Same ansible hosts file)
|
||||
│ │
|
||||
│ ├── apt-up.yml (Playbook to update servers / groups ad hoc)
|
||||
│ │
|
||||
│ └──roles
|
||||
│ └── nginx (Basic ansible role created with ansible-galaxy command)
|
||||
│
|
||||
│
|
||||
├──── plates/
|
||||
│ ├── cpp-cmake (Simple cpp executable template, built using cmake)
|
||||
│ │
|
||||
|
||||
@ -1,43 +0,0 @@
|
||||
# klips
|
||||
Snippets that I frequently use and share
|
||||
|
||||
This repository is a collection of code snippets that I reuse, clone, or frequently refer to in regards to configurations or settings. This can be cloned as a whole and refered to locally as needed, or copied around and used to lay out templates for larger projects.
|
||||
|
||||
The snippets are organized within topic-labeled folders. 'plates' is short-hand for templates, and houses all folders / projects that can be copied and edited / adjusted locally as templates for larger projects.
|
||||
|
||||
Other directories could contain configuration files, bash exports, scripts, etc.
|
||||
|
||||
All snippets will be listed below with the directories in the master branch. If you are not on master, I cant guarentee anything will be anywhere unless otherwise described.
|
||||
|
||||
### Contents
|
||||
|
||||
```
|
||||
https://github.com/shaunrd0/...
|
||||
|
||||
klips/
|
||||
├──── plates/
|
||||
│ ├── cpp-cmake (Simple cpp executable template, built using cmake)
|
||||
│ │
|
||||
│ └── cpp-launcher (Simple cpp launcher template, built using cmake. Easily expandable.)
|
||||
│
|
||||
├──── refs/
|
||||
│ └── doxygenROT (Basic rule-of-thumb for Doxygen commenting)
|
||||
│
|
||||
├──── scripts/
|
||||
│ ├── cmake-build.sh (Script to toss around and build cmake projects)
|
||||
│ │
|
||||
│ ├── setup-vim.sh (Script for setting up vim configuration)
|
||||
│ │
|
||||
│ └── README.md (Any instructions that might be needed for the scripts within this directory)
|
||||
│
|
||||
├──── configs/
|
||||
│ ├──.vimrc (Various settings for vim, can be copied or used with setup-vim.sh)
|
||||
│
|
||||
└──.vimrc-README (What these settings do, output when setup-vim.sh is ran.)
|
||||
|
||||
# Copy / paste below symbols for editing this README / updating hierarchy
|
||||
|
||||
│ ├ ─ └
|
||||
|
||||
```
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
" Single-quote is a comment written to be read
|
||||
" Double-quotes ("") are commented out code and can be removed or added
|
||||
|
||||
" Set tabwidth=2, adjust Vim shiftwidth to the same
|
||||
set tabstop=2 shiftwidth=2
|
||||
|
||||
" expandtab inserts spaces instead of tabs
|
||||
set expandtab
|
||||
|
||||
" autindent inserts the next line at your current depth
|
||||
set autoindent
|
||||
|
||||
" mouse=a allows for mouse interaction with vim when supported
|
||||
set mouse=a
|
||||
|
||||
" Enable Syntax Highlighting in Vim
|
||||
syntax on
|
||||
|
||||
" Enable Pathogen plugin manager
|
||||
execute pathogen#infect()
|
||||
filetype plugin indent on
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
" Single-quote is a comment written to be read
|
||||
" Double-quotes ("") are commented out code and can be removed or added
|
||||
|
||||
" Set tabwidth=2, adjust Vim shiftwidth to the same
|
||||
set tabstop=2 shiftwidth=2
|
||||
|
||||
" expandtab inserts spaces instead of tabs
|
||||
set expandtab
|
||||
|
||||
" autindent inserts the next line at your current depth
|
||||
set autoindent
|
||||
|
||||
" mouse=a allows for mouse interaction with vim when supported
|
||||
set mouse=a
|
||||
|
||||
" Enable Syntax Highlighting in Vim
|
||||
syntax on
|
||||
|
||||
" Enable Pathogen plugin manager
|
||||
execute pathogen#infect()
|
||||
filetype plugin indent on
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
" Single-quote is a comment written to be read
|
||||
" Double-quotes ("") are commented out code and can be removed or added
|
||||
|
||||
" Set tabwidth=2, adjust Vim shiftwidth to the same
|
||||
set tabstop=2 shiftwidth=2
|
||||
|
||||
" expandtab inserts spaces instead of tabs
|
||||
set expandtab
|
||||
|
||||
" autindent inserts the next line at your current depth
|
||||
set autoindent
|
||||
|
||||
" mouse=a allows for mouse interaction with vim when supported
|
||||
set mouse=a
|
||||
|
||||
" Enable Syntax Highlighting in Vim
|
||||
syntax on
|
||||
|
||||
" Enable Pathogen plugin manager
|
||||
execute pathogen#infect()
|
||||
filetype plugin indent on
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
Packages Installed / Updated:
|
||||
- vim, git, clang
|
||||
|
||||
Vimrc Settings:
|
||||
- tabwidth is 2, and set to insert SPACE characters instead of TAB symbols with expandtab
|
||||
- shiftwidth is 2 so we can compensate for the conflict with default tab settings
|
||||
- autoindent is on, when moving to a newline vim will indent to the current depth
|
||||
- syntax highlighting is on
|
||||
- mouse interaction is enabled when supported by connecting systems
|
||||
-- https://github.com/shaunrd0/klips/tree/master/configs
|
||||
|
||||
Plugin Settings:
|
||||
- Pathogen vim plugin manager has been installed and .vimrc configured for its use.
|
||||
-- Install new vim plugins by cloning their repositories into ~/.vim/bundle/
|
||||
-- https://github.com/tpope/vim-pathogen
|
||||
|
||||
- Clang_complete vim plugin has been installed and .vimrc configured for its use.
|
||||
- Code-completion is enabled with default clang_complete settings
|
||||
-- https://github.com/xavierd/clang_complete
|
||||
|
||||
- Supertab vim plugin has been installed and .vimrc configured for its use.
|
||||
- Allows the use of TAB to enable code-completion context menu
|
||||
-- https://github.com/ervandew/supertab
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user