docs: add directory structure
This commit is contained in:
parent
8eaa7b81fa
commit
386c722fd4
15
readme.md
15
readme.md
|
@ -3,11 +3,26 @@
|
||||||
Dotfiles are user-specific configuration files that are typically stored as dotfiles, as in filenames that are prefixed
|
Dotfiles are user-specific configuration files that are typically stored as dotfiles, as in filenames that are prefixed
|
||||||
with a dot or period (.). This project are my personal dotfiles and as such are available for reference and backup.
|
with a dot or period (.). This project are my personal dotfiles and as such are available for reference and backup.
|
||||||
|
|
||||||
|
- [Directory Structure](#directory-structure)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Assumptions](#assumptions)
|
- [Assumptions](#assumptions)
|
||||||
- [Dependency Requirements](#dependency-requirements)
|
- [Dependency Requirements](#dependency-requirements)
|
||||||
- [Setup](#setup)
|
- [Setup](#setup)
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
The directory structure listed below is in general terms and only those special
|
||||||
|
files/directories are listed for explanation purposes.
|
||||||
|
|
||||||
|
```console
|
||||||
|
.
|
||||||
|
├── bin/ < Executable
|
||||||
|
├── system/ < System configuration
|
||||||
|
├── user/ < User configuration
|
||||||
|
├── LICENSE < Project source code license
|
||||||
|
└── README.md < Project read me
|
||||||
|
```
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Assumptions
|
### Assumptions
|
||||||
|
|
Loading…
Reference in New Issue