dotfiles/readme.md

76 lines
2.0 KiB
Markdown
Raw Normal View History

2022-04-12 00:44:16 +00:00
# Dotfiles
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.
2022-10-12 22:59:20 +00:00
- [Directory Structure](#directory-structure)
2022-04-12 00:44:16 +00:00
- [Installation](#installation)
- [Assumptions](#assumptions)
- [Dependency Requirements](#dependency-requirements)
- [Setup](#setup)
2022-10-12 22:59:20 +00:00
## 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
├── CONTRIBUTING.md < Project contributing guidelines
2022-10-12 22:59:20 +00:00
├── LICENSE < Project source code license
└── README.md < Project read me
```
2022-04-12 00:44:16 +00:00
## Installation
### Assumptions
- Have experienced working knowledge within a CLI (command-line interface)
- Understanding of Linux operating system
- Installed all required dependencies as stated in [Dependency Requirements](#dependency-requirements) section
- Installation is done via Linux CLI
- Steps prefixed with a "$" (dollar sign) represents the CLI prompt
- The text after the "$" is to be entered at the CLI
- Setup instructions are an example of installation and configuration
### Dependency Requirements
- BASH v5+
- Git v2+
- GNOME v3+
- GNU Stow v2.3+
### Setup
1. Clone project.
```console
$ git clone https://gitlab.com/adouglas/dotfiles.git
```
1. Change to project directory.
```console
$ cd dotfiles
```
1. Apply configuration.
Choose one of the following methods.
- Specific application
```console
2022-10-12 22:22:52 +00:00
$ cd user/
2022-04-12 00:44:16 +00:00
$ stow fish
```
- All applications
```console
2022-10-12 22:22:52 +00:00
cd user/
2022-04-12 00:44:16 +00:00
$ stow
```
1. Apply GNOME Settings.
GNOME settings are stored within BASH script that utilizes the command "gsettings" to apply desire settings.
```console
2022-10-12 22:22:52 +00:00
$ ./bin/gsconfig
2022-04-12 00:44:16 +00:00
```