docs: add directory structure

This commit is contained in:
Adam 2022-10-12 16:59:20 -06:00
parent 8eaa7b81fa
commit 386c722fd4
No known key found for this signature in database
GPG Key ID: 57EA6558FDBE3320
1 changed files with 15 additions and 0 deletions

View File

@ -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