Modified various readmes

4 files changed, 17 insertions, 99 deletions

diff --git a/README.md b/README.md
index 5a16545..92784e3 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,6 @@
 # Golden Kali
 I believe every Kali VM should be ephemeral. Build it, do your damage, then blow it away. While that's impractical to do it for every single engagement, and since Kali is *almost perfect*, there are still a bunch of things that I modify after a fresh Kali build. Since re-doing all of those tasks is tiresome, I decided to create a solid foundation of "good enough" to start off a fresh build of Kali and download all of the tools I find myself using all the time. So I made this script. It starts a bash script to install pip, then install ansible, then use ansible to download all the appropriate packages, clone the appropriate repositories, and make the appropriate modifications to the system to get it to a point close enough to how I like.
 
-And if you don't like my modifications, I encourage you to fork this repo and make your own changes.
-
 ## Usage
 If you just started up a new instance of **Kali**, to get it to a "proper working setup" that I've come to like, simply run the following command from a terminal:
 
@@ -12,6 +10,18 @@ git clone https://github.com/AgroDan/golden-kali.git && bash ./golden-kali/setup
 
 The previous command used to be a `curl` instruction piped to `bash`. I changed that to a `git clone` instead to change up the way files would be included. It was cleaner and I was able to mess around with ansible's conditional logic a bit more. Additional changes will now prompt you for your password to execute the ansible changes as root. This is necessary to install packages via apt. However now pip and ansible will be installed as the current user rather than the root user. Note you are still allowing code to execute as the root user to install various tools that *I personally* find very useful. They may not be what you find useful, they may not be what you prefer. Please review the code above as it is all open source for your assurance. Know this: I may be installing malicious software, but I wish no mal-intent to you. Peace, love, and hack all the things.
 
+## I Encourage Forking
+
+I expect that my customizations will not necessarily work for everyone. Like I said, this is tailored to _my_ preferences. Feel free to fork the code, or just straight-up copy word for word and start your own. If you do, here's some notes about how to customize:
+
+- This is mostly ansible scripts. Some working knowledge of tuning ansible is required here. It's not difficult [I assure you](https://docs.ansible.com/).
+- I have split up work into three roles:
+    - If you need to modify packages installed from the Package manager, modify `/roles/package-mgmt/tasks/main.yml`
+    - If you need to modify one-off packages installed from `git`, `pip`, `gem` or even how to compile them, modify `/roles/individual-apps/tasks/main.yml`
+    - If you need to modify desktop-based configurations, modify `/roles/custom-config/tasks/main.yml`
+- Even if you don't know ansible, you can probably guess what you need to change by using what I wrote as an example template.
+- Contributions are always welcome! I know enough ansible to do neat things, but I'm by no means an expert. Feel free to tell me what I'm doing wrong and how I can go about making it even better!
+
 ## Changelog
 
 - Latest change: Ansible roles!
diff --git a/roles/custom-config/README.md b/roles/custom-config/README.md
index 225dd44..9a20a30 100644
--- a/roles/custom-config/README.md
+++ b/roles/custom-config/README.md
@@ -1,38 +1,4 @@
 Role Name
 =========
 
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
-
-Role Variables
---------------
-
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+This role handles customization of the desktop experience only. Adding things like zsh functions I use, getting rid of mouse interactivity with vim (because who in their right mind thought this was a good idea???), and other small tweaks that I needed. Put customization in here.
diff --git a/roles/individual-apps/README.md b/roles/individual-apps/README.md
index 225dd44..004e8b6 100644
--- a/roles/individual-apps/README.md
+++ b/roles/individual-apps/README.md
@@ -1,38 +1,9 @@
 Role Name
 =========
 
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+This role will install individual packages that are _not_ tied to the package management system, IE apt. This also applies to git repositories and the like, as well as one-off compilation and build instructions, such as JumboJohn and Kerbrute.
 
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+Just using a link to the compiled ysoserial .jar file.
diff --git a/roles/package-mgmt/README.md b/roles/package-mgmt/README.md
index 225dd44..2c23fcf 100644
--- a/roles/package-mgmt/README.md
+++ b/roles/package-mgmt/README.md
@@ -1,38 +1,9 @@
 Role Name
 =========
 
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+This role will handle any OS-level patching and package installs, including the installation of keys for repositories and such. This role typically takes a while to run because I always make sure I am patched and up to date before doing anything, and then of course the individual packages just take a while to install.
 
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+I have added the URLs to the specific keys I am using to install the repositories for things like Docker and Sublime Text.