Skip to content

Bennett-Wendorf/dotfiles

Repository files navigation

Stargazers Issues


Dotfiles

This repository serves as a backup for all of my configuration files for my Arch Linux system that I use on a daily basis. It also houses a few bash scripts I have written to aid in the install process of both these configs and a full Arch system.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgements

About The Project

This project began in the summer of 2020 when I decided to jump ship from Windows and move to GNU/Linux full time on my main system. When I started out, I fell in love with customizing, or 'ricing,' my system. Because of this, I needed a safe place to store all my config files that I was creating. Thus, this repository was born. Now that I've been on Linux for over a year, I decided to start working on some installation scripts to make the process of reinstalling my system easier. Check out the Getting Started section of this page. Enjoy!

Built With

This project is written in a variety of languages and configurations as it is a full compilation of the config files I use on my Arch linux system on a daily basis.

Getting Started

NOTE:

Regardless of the method chosen, you'll need to set up the .xprofile-template file to make everything work properly. Take the included template (.xprofile-tempate) and rename it to .xprofile. Then, inside that file, fill in the details with your API keys for Open Weather Map and IP Info. Both are totally free to sign up for :)

There are three main ways you can utilize this repository. The first and maybe simplist is to just grab the configs that you want from here and paste them into your own dirctories. Alternatively, I have created scripts to either help you just install the config files, or to install a full Arch Linux system from the ground up. For either of these methods, clone this repo, navigate into the ArchInstall directory, and run the appropriate script.

Config File Installation

The most basic way to just install my config files is to just run the install_configs.sh script. This will ensure my configs have been downloaded, back up any of your configs, and then install my. See the .old files and directories for the backed up files. The other alternative if you want all of the apps to be installed as well is to run the install_basic_apps.sh script to install all of the apps that I use before installing the configs. NOTE: Running the install_basic_apps.sh script will also run the install_configs.sh script, so no need to run it again.

Full Arch System Installation

If you would like to use my scripts to install a full Arch Linux system from the ground up, you can do so by following the guide that I will be working on in the wiki section of this repository. For now, that is a work in progress, but the gist of it is you should install up to the point where you chroot into the new system, and then clone this repository and run the install_full_system.sh script to finish the install.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

If you find an issue in existing code, feel free to use the above procedure to generate a change, or open an issue for me to fix it.

License

Most of this repository is distributed under the MIT License with a few exceptions. See LICENSE for more information.

Contact

Bennett Wendorf - Website - bennettwendorf@gmail.com

Project Link: https://github.com/Bennett-Wendorf/dotfiles

Acknowledgements