Fix READMEs

README.md

@@ -43,16 +43,20 @@ klips/
 ### ansible
 
 Ansible roles, playbooks
+
+Playbooks
  - apt-up.yml - Playbook to update servers / groups ad hoc
  - core.yml  - Playbook example for using core configuration role
  - docker.yml - Playbook example for using docker install role (Debian / Ubuntu)
  - hosts - Sample / partially default ansible hosts file
  - make-host.yml - Playbook example for using multiple roles together to create a new host
  - nginx.yml - Playbook example for using nginx role 
- - roles - Some simple Ansible roles created with `ansible-galaxy init <role> --offline` command
+
-  - core - Role to configure a new host with basic authentication / package settings
+Roles 
-  - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu)
+ - Basic ansible role created with ansible-galaxy command
-  - nginx - Role to install and configure a new nginx webserver on a host 
+ - core - Role to configure a new host with basic authentication / package settings
+ - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu)
+ - nginx - Role to install and configure a new nginx webserver on a host 
 
 ### configs
  - .vimrc - Various settings for vim, can be copied or used with setup-vim.sh) 
@@ -66,22 +70,29 @@ Ansible roles, playbooks
  - doxygenROT - Basic rule-of-thumb for Doxygen commenting
 
 ### scripts
- - adduser.sh - Script to add new user, run with sudo if you want to configure / allow user to sudo
+
-  - ./adduser - (Print help text)
+adduser.sh - Script to add new user, run with sudo if you want to configure / allow user to sudo
-  - ./adduser <name> <userID> - (Don't need sudo if new user doesn't need it)
+ - `./adduser` - (Print help text)
-  - sudo ./adduser <name> <userID>
+ - `./adduser <name> <userID>` - (Don't need sudo if new user doesn't need it)
-  - sudo ./adduser jeff 1005 - (Create jeff user and assign userID to 1005)
+ - `sudo ./adduser <name> <userID>`
-  - Follow prompts to configure password / sudo depending on needs of new user 
+ - `sudo ./adduser jeff 1005` - (Create jeff user and assign userID to 1005)
- - cmake-build.sh - Script to toss around and build cmake projects
+ - Follow prompts to configure password / sudo depending on needs of new user 
- - README.md - Further clarification of scripts
+ 
- - setup-vim.sh - Script for setting up vim configuration
+cmake-build.sh 
-  - Includes Pathogen Plugin manager
+ - Script to toss around and build cmake projects
-  - Includes auto-completion (Clang_completion)
+ 
-  - Supertab completion interaction (Tab to interact with completion context)
+README.md
-  - Syntax highlighting
+ - Further clarification of scripts
-  - Tabsize 2, use spaces in place of tabs
+
-  - auto indentation, mouse interaction when supported
+setup-vim.sh
-  - Custom keybind (Ctrl-e for jumping windows || Ctrl-w still works if not in a tabbed terminal where the same will close the tab)
+ - Script for setting up vim configuration
-  - See klips/configs/.vimrc-README for more information
+ - Includes Pathogen Plugin manager
+ - Includes auto-completion (Clang_completion)
+ - Supertab completion interaction (Tab to interact with completion context)
+ - Syntax highlighting
+ - Tabsize 2, use spaces in place of tabs
+ - auto indentation, mouse interaction when supported
+ - Custom keybind (Ctrl-e for jumping windows || Ctrl-w still works if not in a tabbed terminal where the same will close the tab)
+ - See klips/configs/.vimrc-README for more information
 
 

ansible/README.md

@@ -11,8 +11,8 @@ Playbooks
  - nginx.yml - Playbook example for using nginx role 
 
 Roles 
- - roles - Basic ansible role created with ansible-galaxy command
+ - Basic ansible role created with ansible-galaxy command
-  - core - Role to configure a new host with basic authentication / package settings
+ - core - Role to configure a new host with basic authentication / package settings
-  - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu)
+ - docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu)
-  - nginx - Role to install and configure a new nginx webserver on a host 
+ - nginx - Role to install and configure a new nginx webserver on a host 
 

ansible/roles/README.md

@@ -9,21 +9,25 @@ klips/ansible/roles/...
 
 All of these roles assume you are using the apt package manager, and running a Debian / Ubuntu system. 
 
+
 core
 ------------
 
 A simple role for configuring a set of packages / settings on a new Ubuntu host using Ansible.
 
-Packages Added / Configured
+### Packages Added / Configured
- - Git
+
-  - Configure / set user name and email
+Git
- - SSH
+ - Configure / set user name and email
-  - MOTD (Template, replacable, displayed on login.)
+
-  - PAM (Template, replacable, authusers file to bypass)
+SSH
-  - authusers (Add users to file to bypass PAM settings)
+ - MOTD (Template, replacable, displayed on login.)
- - Vim
+ - PAM (Template, replacable, authusers file to bypass)
-  - Install Vim
+ - authusers (Add users to file to bypass PAM settings)
-  - Run https://github.com/shaunrd0/klips/blob/master/scripts/setup-vim.sh
+
+Vim
+ - Install Vim
+ - Run https://github.com/shaunrd0/klips/blob/master/scripts/setup-vim.sh
 
 
 docker

ansible/roles/core/README.md

@@ -3,16 +3,19 @@ core
 
 A simple role for configuring a set of packages / settings on a new Ubuntu host using Ansible.
 
-Packages Added / Configured
+### Packages Added / Configured
- - Git
+
-  - Configure / set user name and email
+Git
- - SSH
+ - Configure / set user name and email
-  - MOTD (Template, replacable, displayed on login.)
+
-  - PAM (Template, replacable, authusers file to bypass)
+SSH
-  - authusers (Add users to file to bypass PAM settings)
+ - MOTD (Template, replacable, displayed on login.)
- - Vim
+ - PAM (Template, replacable, authusers file to bypass)
-  - Install Vim
+ - authusers (Add users to file to bypass PAM settings)
-  - Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh
+
+Vim
+ - Install Vim
+ - Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh
 
 Requirements
 ------------