docs: add readme
This commit is contained in:
parent
0cd5d1291e
commit
2b2c1f4f59
|
@ -0,0 +1,57 @@
|
|||
# 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.
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Assumptions](#assumptions)
|
||||
- [Dependency Requirements](#dependency-requirements)
|
||||
- [Setup](#setup)
|
||||
|
||||
## 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
|
||||
$ stow fish
|
||||
```
|
||||
- All applications
|
||||
```console
|
||||
$ stow
|
||||
```
|
||||
1. Apply GNOME Settings.
|
||||
|
||||
GNOME settings are stored within BASH script that utilizes the command "gsettings" to apply desire settings.
|
||||
```console
|
||||
$ ./gsconfig
|
||||
```
|
Loading…
Reference in New Issue