todo-application - www.codemadness.org - www.codemadness.org saait content files
 (HTM) git clone git://git.codemadness.org/www.codemadness.org
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       todo-application (5054B)
       ---
            1 1<- Back        /        codemadness.org        70
            2 i                codemadness.org        70
            3 i                codemadness.org        70
            4 i# A simple TODO application                codemadness.org        70
            5 i                codemadness.org        70
            6 iLast modification on 2022-07-01                codemadness.org        70
            7 i                codemadness.org        70
            8 iThis article describes a TODO application or workflow.                codemadness.org        70
            9 i                codemadness.org        70
           10 i                codemadness.org        70
           11 i## Workflow                codemadness.org        70
           12 i                codemadness.org        70
           13 iIt works like this:                codemadness.org        70
           14 i                codemadness.org        70
           15 i* Open any text editor.                codemadness.org        70
           16 i* Edit the text.                codemadness.org        70
           17 i* Save it in a file (probably named "TODO").                codemadness.org        70
           18 i* Feel happy about it.                codemadness.org        70
           19 i                codemadness.org        70
           20 i                codemadness.org        70
           21 i## The text format                codemadness.org        70
           22 i                codemadness.org        70
           23 iThe text format I use is this:                codemadness.org        70
           24 i                codemadness.org        70
           25 i        [indendations]<symbol><SPACE><item text><NEWLINE>                codemadness.org        70
           26 i                codemadness.org        70
           27 iMost of the time an item is just one line.                codemadness.org        70
           28 iThis format is just a general guideline to keep the items somewhat structured.                codemadness.org        70
           29 i                codemadness.org        70
           30 i                codemadness.org        70
           31 i## Symbols                codemadness.org        70
           32 i                codemadness.org        70
           33 iItems are prefixed with a symbol.                codemadness.org        70
           34 i                codemadness.org        70
           35 i* - is an item which is planned to be done at some point.                codemadness.org        70
           36 i* x is an item which is done.                codemadness.org        70
           37 i* ? is an item which I'm not (yet) sure about. It can also be an idea.                codemadness.org        70
           38 i                codemadness.org        70
           39 iI use an indendation with a TAB before an item to indicate item dependencies.                codemadness.org        70
           40 iThe items can be nested.                codemadness.org        70
           41 i                codemadness.org        70
           42 iFor the prioritization I put the most important items and sections from the top                codemadness.org        70
           43 ito the bottom. These can be reshuffled as you wish of course.                codemadness.org        70
           44 i                codemadness.org        70
           45 iTo delete an item you remove the line. To archive an item you keep the line.                codemadness.org        70
           46 i                codemadness.org        70
           47 i                codemadness.org        70
           48 i## Sections                codemadness.org        70
           49 i                codemadness.org        70
           50 iA section is a line which has no symbol. This is like a header to group items.                codemadness.org        70
           51 i                codemadness.org        70
           52 i                codemadness.org        70
           53 i## Example                codemadness.org        70
           54 i                codemadness.org        70
           55 i        Checklist for releasing project 0.1:                codemadness.org        70
           56 i        - Test project with different compilers and check for warnings.                codemadness.org        70
           57 i        - Documentation:                codemadness.org        70
           58 i                - Proofread and make sure it matches all program behaviour.                codemadness.org        70
           59 i                - Run mandoc -Tlint on the man pages.                codemadness.org        70
           60 i                ? Copy useful examples from the README file to the man page?                codemadness.org        70
           61 i        - Run testsuite and check for failures before release.                codemadness.org        70
           62 i                        codemadness.org        70
           63 i                        codemadness.org        70
           64 i        project 0.2:                codemadness.org        70
           65 i        ? Investigate if feature mentioned by some user is worth adding.                codemadness.org        70
           66 i                codemadness.org        70
           67 i                codemadness.org        70
           68 i# Example: secure remote cloud-encrypted edit session(tm)                codemadness.org        70
           69 i                codemadness.org        70
           70 i        ssh -t host 'ed TODO'                codemadness.org        70
           71 i                codemadness.org        70
           72 i# Example: multi-user secure remote cloud-encrypted edit session(tm)                codemadness.org        70
           73 i                codemadness.org        70
           74 i        ssh host                codemadness.org        70
           75 i        tmux or tmux a                codemadness.org        70
           76 i        ed TODO                codemadness.org        70
           77 i                codemadness.org        70
           78 i# Example: version-controlled multi-user secure remote cloud-encrypted edit session(tm)                codemadness.org        70
           79 i                codemadness.org        70
           80 i        ssh host                codemadness.org        70
           81 i        tmux or tmux a                codemadness.org        70
           82 i        ed TODO                codemadness.org        70
           83 i        git add TODO                codemadness.org        70
           84 i        git commit -m 'TODO: update'                codemadness.org        70
           85 i                codemadness.org        70
           86 i## Pros                codemadness.org        70
           87 i                codemadness.org        70
           88 i* When you open the TODO file the most important items are at the top.                codemadness.org        70
           89 i* The items are easy to read and modify with any text editor.                codemadness.org        70
           90 i* It is easy to extend the format and use with other text tools.                codemadness.org        70
           91 i* The format is portable: it works on sticky-notes on your CRT monitor too!                codemadness.org        70
           92 i* No monthly online subscription needed and full NO-money-back guarantee.                codemadness.org        70
           93 i                codemadness.org        70
           94 i                codemadness.org        70
           95 i## Cons                codemadness.org        70
           96 i                codemadness.org        70
           97 i* Complex lists with interconnected dependencies might not work, maybe.                codemadness.org        70
           98 i* It's assumed there is one person maintaining the TODO file. Merging items                codemadness.org        70
           99 i  from multiple people at the same time in this workflow is not recommended.                codemadness.org        70
          100 i* It is too simple: noone will be impressed by it.                codemadness.org        70
          101 i                codemadness.org        70
          102 i                codemadness.org        70
          103 iI hope this is inspirational or something,                codemadness.org        70
          104 .