Jefer: A Simple Dotfiles Manager

Jefer is a simple minimalist & cross-platform tool for manaing your "dotfiles" across various machines running on different operating systems!

Inspiration Behind Jefer

Jefer stands on the shoulders of giants & its UI/UX has been greatly influenced by them. It wouldn't have seen the light of the day if not for those other tools in question.

Here are the tools which has inspired me to start working on Jefer:

1. YADM
2. GNU/Stow
3. Chezmoi

I've used all the tools mentioned above but they all fell short in one way or the other. Hence I decided to build Jefer to meet those expectations for me. Here are the list of expectations I have for Jefer:

1. It should be cross-platform which means it should work on almost all popular OSes.
2. No need to bloat the UI/UX with too many features, make the tool to serve a single purpose i.e to manage dotfiles, that's it nothing more, nothing less.
3. Make use soft symlinks, so that its easy to manage the dotfiles from one single "source of truth" which is also expected to be version-controlled!

TLDR: I needed a minimal tool which would also create symlinks instead of working with raw files & would stay away from my workflow as much as possible, so I built Jefer instead.

Usage Guidelines

TODO: Write a detailed usage guideline for the tool

Contributing to the Project

The project is developed in the open-source & it wouldn't see the light of the day if not for the enormous amount of help received from the open-source community. And if you want to personally contribute to the project, here's what you can do:

1. Find & report bugs or other related inconsisties with using this tool.
2. Help develop/maintain the project by sharing PRs, writing docs & more.
3. Sponsoring this project so that I can spend more time working on it.

Do remember, there's more than one way to contribute to this project like spreading word about how useful this tool has proved to your use-case & more. So don't hesitate to contribute to the project in rather unconventional ways.

Usage Terms & Conditions (T&Cs)

The project is developed & released under the open-source MIT license. Hence you are free to copy, distribute, modify & much more the source code of this project as you deem it fit!

For more licensing information, refer to the LICENSE document.

Stuff TO-DO

• Add documentations using https://getdoks.org