Code Monkey home page Code Monkey logo

dotfiles-yadm's Introduction

License

๐Ÿ  dotfiles-yadm

source: https://github.com/techie2000/dotfiles-yadm

โ„น๏ธ About

My dotfiles as managed by yadm - https://yadm.io/

This dotfile repo uses the yadm tool (https://thelocehiliosan.github.io/yadm/docs/overview) in order to provision and configure dotfiles on a system.

๐Ÿ’พ Usage/Installation

Prerequisite: yadm installation (https://yadm.io/docs/install)

Get the Dotfiles onto the system

yadm clone [email protected]:techie2000/dotfiles-yadm.git

If the clone results in warnings because of pre-existing dotfiles, overwrite the existing files.

yadm reset --hard HEAD

Check for changes in your local dotfiles

As you use use system, you will inevitably make changes that you may want back in the future; ID them with

yadm diff

Commit changes back to the repo

and keep them under source control with

yadm add -u :/
yadm commit -m "The description of changes"
yadm push

โญ Features

XDG Base Directory Compliance

Dotfiles are organized to comply with XDG base directory specification as much as possible.

For more information, see this page on the Arch Wiki.

Bootstrap Script

yadm has a built-in bootstrap feature which enables further configuration of dotfiles.

The included bootstrap script will perform the following tasks:

  • Install applications.
    • If Xorg is installed on the system, offer to install GVim instead.
    • If using Debian/Ubuntu, install thefuck using pip instead.
  • Bootstrap Zsh.
    • Prepare Zsh configuration files and directory.
    • Make Zsh the default shell.
    • Add system-wide configuration of $ZDOTDIR in /etc/zsh/zshenv.
  • Bootstrap Vim.
    • Prepare Vim configuration files and directory.
    • Automatically install Vim plugins.
  • Install fonts (optional).
  • Cleanup home directory (optional).

Fonts

Fonts that include glyphs (icons) must be installed on the system to take full advantage of the themed Zsh prompt. Bootstrap script will therefor offer installation of the excellent Nerd Fonts.

Choose between the following font installatoin options:

  1. None. Do not install any fonts.
  2. Basic. Install only the Source Code Pro font family.
  3. Complete. Install the complete collection of Nerd Fonts.

Fonts will be installed in the ~/.local/share/fonts directory.

Cleanup Home Directory

Bootstrap script will scan the root of the home directory (~/) for known dotfiles. If any are found, script will prompt them for removal. See XDG base directory compliance for more information.

๐Ÿ“ฆ Applications

#to do: put this in a table and add in links descriptions

  • [cargo]:
  • [duf]:
  • [flatpak]:
  • git: Version control system (VCS).
  • fzf: Command-line fuzzy finder.
  • [htop]:
  • [iftop]:
  • [iotop]:
  • mc: Terminal file manager.
  • [node-js-beautify]:
  • [nq]:
  • [postgresql]:
  • [postgresql-client]:
  • [postgresql-client-common]:
  • [postgresql-contrib]:
  • ranger: Terminal file manager.
  • The Fuck: Corrects previous console command.
  • [tidy]:
  • Vim: Terminal text editor.
  • [yamllint]:
  • Zsh: Preferred shell.

โค๏ธ Credits

Various files are based on, heavily influenced by, or down-right lifted from pwyde's

dotfiles-yadm's People

Contributors

techie2000 avatar

Watchers

 avatar

dotfiles-yadm's Issues

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.