From 8d70280c0f784872a5f8309d50bf6337e4ed20a3 Mon Sep 17 00:00:00 2001 From: oreodave Date: Mon, 18 Nov 2019 23:17:44 +0000 Subject: +subheading on 'how to use' for a project workflow --- README.org | 8 ++++++++ 1 file changed, 8 insertions(+) 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) -- cgit v1.2.3-13-gbd6f