Code Monkey home page Code Monkey logo

dotfiles's Introduction

.dotfiles

Goal

The goal of this repo is to completely automate the process of setting up my desktop environment on whatever Arch-based installation I'm running.

Currently (as of writing this) I am running an Arch-based distro called EndeavourOS, but plan on moving to a custom Arch installation later down the line. But since I'm often too lazy to set it all up manually, I've decided to start slowly putting together a set of tools I could run on any Arch-based installation.

Getting Started

This repo is meant for my Arch + i3wm setup so these instructions assume an Arch-based distro, so if you use a different distro, you'll need to look for and install the necessary dependencies manually (see below).

This repo makes heavy use of Makefiles because Arch very often comes with it already installed.

The dotfiles in this repo are also split up into multiple templates (where it makes sense to do so). These split templates are put together using go-tpl, a simple go application that just combines templates in a recursive manner. The main reason for this is because i3wm does not support split configurations and so I decided to solve it while having fun. The source code for go-tpl can be found under the utils/go-tpl/ directory.

The install process this repo follows is as follows:

  1. Build all the included utilities (currently just go-tpl)
  2. Put together the necessary configurations using go-tpl
  3. Create symbolic links for all the produced configurations

Dependencies

In order to have this repo work from anything from a clean Arch installation all the way up to an Arch-based distro like EndeavourOS, I'll try to include all the dependencies needed in here. This may take a while, but sooner or later I should have it fully-complete. As such, I advise you to check the source code for yourself to see if there's anything missing before even attempting to install this.

For the time being, we can assume the following dependencies:

sudo pacman -S --needed make i3-wm i3lock polybar go scrot imagemagick

Installing

Since the goal of this project is to have everything automated, you should generally be all set with just running the following:

make install

Modules

modules/spotify

In order for the spotify module to work, make sure you have spotifyd and playerctl installed and configured. Additionally, add the following options to ~/.config/spotifyd/spotifyd.conf.

on_song_change_hook = "sh ~/.dotfiles/scripts/spotifyd-event-hook.sh"
use_mpris = true

dotfiles's People

Contributors

xprnio avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.