Giter Site home page Giter Site logo

dreadwarrior / dotfiles Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 243 KB

yadm managed dotfiles

Home Page: https://dreadwarrior.github.io/dotfiles/

License: MIT License

CSS 0.09% Shell 33.37% Makefile 1.42% Roff 10.83% HTML 52.52% Vim Script 1.37% Java 0.39%
bash dotfiles macos homebrew git manpages

dotfiles's Introduction

dotfiles

yadm managed dotfiles.

Goals

  1. Minimal dependency footprint (yadm uses git and bash)
  2. No git submodules

Installation / setup

Linux

~$ sudo apt install yadm
~$ cd $HOME
~$ yadm clone [email protected]:dreadwarrior/dotfiles
~$ # the next step is optional for YADM configuration on a business machine:
~$ yadm config local.class work
~$ yadm alt
~$ source ~/.bashrc
~$ dotfiles_install

MacOS

# Install Homebrew + yadm
~$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
~$ brew install yadm

# Update bash
~$ brew install bash
~$ sudo bash -c 'echo /usr/local/bin/bash >> /etc/shells'
~$ chsh -s /usr/local/bin/bash

# same as on Linux:
~$ cd $HOME
~$ yadm clone [email protected]:dreadwarrior/dotfiles
~$ # the next step is optional for YADM configuration on a business machine:
~$ yadm config local.class work
~$ yadm alt
~$ source ~/.bashrc
~$ dotfiles_install
~$ $(brew --prefix)/opt/fzf/install

Development

Requirements

  • Pandoc, e.g. via Homebrew brew install pandoc
  • ShellCheck, e.g. via Homebrew brew install shellcheck
  • JBang, e.g. via SDKMAN!

Update .local/bin-commands

  • use Posix shell style whenever possible
  • consider using Argbash if argument and option handling is needed (non-Posix style only :/)
  • use shellcheck for linting
  • don't forget chmod u+x
  • add Pandoc compatible man page markdown source in /man subdirectory
  • optional:
    • adjust dotfiles_commands.7.md with link to new man page
    • adjust index.md with link to new man page

Build man pages

 make clean all

Add new man page sections

  1. Add new variables with appropriate values (use existing ones as examples):

    BUILD_DIR_MAN_SECTIONnnn
    BUILD_DIR_HTM_SECTIONnnn
    SRCS_SECTIONnnn
    OBJS_MAN_SECTIONnnn
    OBJS_HTM_SECTIONnnn
    

    Where nnn reflects the new section (e.g. "2").

  2. Add new OBJS_ variables to all-target:

  3. Add new rules for BUILD_DIR_MAN_ and BUILD_DIR__HTM_ targets

  4. Adjust clean target for cleaning up new build dirs

Upgrade gh-pages branch

Create new branch if not existing already in the repository:

true | git mktree | xargs git commit-tree | xargs git branch gh-pages

Write Git tree object with current (committed) state of the static resources folder:

 > git write-tree --prefix=.local/bin/man
 < <Git Tree ID>

Commit the tree to the specific branch:

 > git commit-tree -p gh-pages -m "<Your commit message>" <Git Tree ID>
 < <Git Commit ID>

Update references on specific branch:

 git update-ref refs/heads/gh-pages <Git Commit ID>

The branch is now ready to be pushed to upstream.

TODOs

  1. Test if these files are really needed and check security concerns:

    • .local/share/gtg/{gtg_tasks,projects,tags}.xml
    • .local/share/gnome-shell/extensions
  2. Integrate global system name probing (uname -s), individual usage by dotfiles-install/* scripts

Links / Notes

dotfiles's People

Contributors

dreadwarrior avatar

Watchers

 avatar

dotfiles'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.