aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authororeodave <aryadevchavali1@gmail.com>2019-11-18 23:17:44 +0000
committeroreodave <aryadevchavali1@gmail.com>2019-11-18 23:17:44 +0000
commit8d70280c0f784872a5f8309d50bf6337e4ed20a3 (patch)
treeff1e08c303f5f93df0c361b2b5c5705d750accaf
parent10c8ba358c52e6e9dc9fe642e2ca4a4bd63eba6f (diff)
downloaddotfiles-8d70280c0f784872a5f8309d50bf6337e4ed20a3.tar.gz
dotfiles-8d70280c0f784872a5f8309d50bf6337e4ed20a3.tar.bz2
dotfiles-8d70280c0f784872a5f8309d50bf6337e4ed20a3.zip
+subheading on 'how to use' for a project workflow
-rw-r--r--README.org8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.org b/README.org
index 4f4a1c0..84f9d92 100644
--- a/README.org
+++ b/README.org
@@ -50,3 +50,11 @@ is literally just for me).
- Use fd/ripgrep/ag as much as possible outside, in the terminal. They're
insanely useful. Integrating them with your editors is cool, but using them
raw has benefits as well
+** Project by project
+Setup a README.org in the root, with a notes.org and todo.org in .git (to not be
+tracked by git unless you want it to of course). Write up some documentation in
+README.org. Use notes for quick note taking about the project, todo.org for
+todos recording. For scripting languages or learning a language, use .org files
+and source code blocks to generate code, writing descriptions and other things
+around them to explain them better (with an added benefit to compile to a PDF
+for a nice document)