From 386c722fd42477b7251e2130a13bb3e0f6a4ae63 Mon Sep 17 00:00:00 2001 From: Adam <2327942-adamsdesk@users.noreply.gitlab.com> Date: Wed, 12 Oct 2022 16:59:20 -0600 Subject: [PATCH] docs: add directory structure --- readme.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/readme.md b/readme.md index e1ca1cb..82eaeed 100644 --- a/readme.md +++ b/readme.md @@ -3,11 +3,26 @@ 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. +- [Directory Structure](#directory-structure) - [Installation](#installation) - [Assumptions](#assumptions) - [Dependency Requirements](#dependency-requirements) - [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 ### Assumptions