Browse Source

Fix markup (paths are not code)

Alois Mahdal 8 years ago
parent
commit
ab7c0ec6e8
1 changed files with 4 additions and 4 deletions
  1. 4
    4
      guidelines/hierarchy.md

+ 4
- 4
guidelines/hierarchy.md View File

54
 ### src ###
54
 ### src ###
55
 
55
 
56
 Everything that is supposed to be (directly or in some "built" form)
56
 Everything that is supposed to be (directly or in some "built" form)
57
-deployed on the target host goes under `src`.
57
+deployed on the target host goes under *src*.
58
 
58
 
59
 Under this folder, it makes sense to have files divided in sub-folders
59
 Under this folder, it makes sense to have files divided in sub-folders
60
 named reminiscent to the target paths.  For example, host configuration
60
 named reminiscent to the target paths.  For example, host configuration
61
-files should be under `src/etc`, library source files under `src/lib`,
62
-future binaries under `src/bin`, future manpages to `src/man`...
61
+files should be under *src/etc*, library source files under *src/lib*,
62
+future binaries under *src/bin*, future manpages to *src/man*...
63
 
63
 
64
 Note that it does not matter whether there is some significant build
64
 Note that it does not matter whether there is some significant build
65
 procedure to happen; it's OK if most of the files here are just verbatim
65
 procedure to happen; it's OK if most of the files here are just verbatim
157
     │   │   ├── TF_RUN          #
157
     │   │   ├── TF_RUN          #
158
     │   │   ├── oracle          #   hierarchy is influenced by TFKit
158
     │   │   ├── oracle          #   hierarchy is influenced by TFKit
159
     │   │   │   └── ...         #   which itself is actually embedded
159
     │   │   │   └── ...         #   which itself is actually embedded
160
-    │   │   └── test            #   under `utils` directory below
160
+    │   │   └── test            #   under *utils* directory below
161
     │   │       └── ...         # /
161
     │   │       └── ...         # /
162
     │   └── ...                 #
162
     │   └── ...                 #
163
     └── utils           # \
163
     └── utils           # \