style(README):Re-organize Contents to include some files
authorSteven Baltakatei Sandoval <baltakatei@gmail.com>
Sat, 19 Aug 2023 20:32:11 +0000 (20:32 +0000)
committerSteven Baltakatei Sandoval <baltakatei@gmail.com>
Sat, 19 Aug 2023 20:32:11 +0000 (20:32 +0000)
README.org

index 121229d56dc11d9b32bed5b80dd2e7acdef62fef..a090e797cad2fdfec3e1607802d91f90f446730f 100644 (file)
@@ -16,17 +16,25 @@ Some drawings may be uploaded to Wikimedia Commons. Notable sets include:
 - [[https://commons.wikimedia.org/wiki/File:Technical_drawing_templates_(ISO_5457_1999_Sizes_A0-A4).pdf][BK-2020-04-PID-1]]: Chemical engineering symbols ([[https://en.wikipedia.org/wiki/ISO_10628][ISO 10628]]-2:2012 Symbols)
 - [[https://commons.wikimedia.org/wiki/File:Technical_drawing_templates_(ISO_5457_1999_Sizes_A0-A4).pdf][BK-2020-04-TMP-1]]: Technical drawing templates (ISO 5457:1999 Sizes A0—A4)
 
-** Directories
-*** [[File:DEL][~DEL~]] : Deliverables
-May include plain SVG files and exported PDF files. This is probably
+** Contents
+*** Directories
+**** ~DEL~ : Deliverables
+A directory that may include plain SVG files and exported PDF files. This is probably
 what you want.
-*** [[File:DWG][~DWG~]] : Drawing source files
-May include [[https://inkscape.org/][Inkscape]] SVG files.
-*** [[File:EXEC][~EXEC~]]: Executable files
-May include scripts useful for manipulating files.
-*** [[File:IMG][~IMG~]] : Reference image files
-May include various image files used in creation of project source
+**** ~DWG~ : Drawing source files
+A directory that may include [[https://inkscape.org/][Inkscape]] SVG files.
+**** ~EXEC~ : Executable files
+A directory that may include scripts useful for manipulating files.
+**** ~IMG~: Reference image files
+A directory that may include various image files used in creation of project source
 files.
+*** Files
+**** ~README.org~
+This file.
+**** ~REVISIONS.org~
+A file containing a detailed version history of each drawing.
+**** ~TODO.org~
+A file containing a list of pending tasks for the project.
 
 ** Usage
 *** Generate a combined PDF