From 7b2fe537b7da1ad23d73ca34b5d5d3535eec3fdb Mon Sep 17 00:00:00 2001 From: Shaun Reed Date: Fri, 26 Jul 2019 15:08:59 -0400 Subject: [PATCH] Updated README and added a .gitignore --- .gitignore | 1 + README.md | 27 +++++++++++++++++++++------ 2 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/README.md b/README.md index 8314070..9213df8 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,33 @@ All snippets will be listed below with the directories in the master branch. If ### Contents ``` -https://github.com/ - -shaunrd0/klips/ +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.) │ -│# Custom Templates +├──── refs/ +│ └── doxygenROT (Basic rule-of-thumb for Doxygen commenting) │ -├── plates/ - └── cpp-cmake +├──── scripts/ +│ └── cmake-build.sh (Script to toss around and build cmake projects) # Copy / paste below symbols for editing this README / updating hierarchy │ ├ ─ └ ``` +###Scripts + +I write these scripts for my own use, and you may need to tweak them slightly to suit your needs. + +Never run a script you can't read or understand. Comments can be found in the scripts, usually explaining them block-by-block. Below is my personal use cases for the scripts, to provide further insight into how I use them and how they might be useful to you. + +####cmake-build.sh + +I usually run this script within whatever directory I'm working in, hence the infinite loop, I leave the script running until I'm done with my work and move to a new directory / cmake project. + + +