|
| 1 | +<div align="center"> |
| 2 | + <img |
| 3 | + width="500" |
| 4 | + alt=".dotfiles" |
| 5 | + src="https://i.imgur.com/SzBeVhB.png"> |
| 6 | +<br> |
| 7 | +<br> |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +<h4> |
| 12 | + 💻🚀 Custom dotfiles for UNIX based systems |
| 13 | +</h4> |
| 14 | + |
| 15 | +<a href="#ℹ️-about">ℹ️ About</a> • |
| 16 | +<a href="#-installation">📥 Installation</a> • |
| 17 | +<a href="#-features">📋 Features</a> • |
| 18 | +<a href="#-contributing">👥 Contributing</a> • |
| 19 | +<a href="#-credits">🎯 Credits</a> • |
| 20 | +<a href="#-license">🚩 License</a> |
| 21 | + |
| 22 | +</div> |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## ℹ️ About |
| 27 | + |
| 28 | +Personal .dotfiles for quick configuration of my UNIX-based devices. They are tailored to my needs and do not claim to be the right solution for ideal .dotfiles. |
| 29 | + |
| 30 | +> 💡 As a starting point to get all your configuration files and scripts organised I recommend you to use [dotly](https://github.com/CodelyTV/dotly), which is a project that describes itself as a simple and fast dotfiles framework. |
| 31 | +
|
| 32 | +## 📥 Installation |
| 33 | + |
| 34 | +Using `wget`: |
| 35 | + |
| 36 | +```bash |
| 37 | +bash <(wget -qO- https://raw.githubusercontent.com/borjapazr/dotfiles/HEAD/installer) |
| 38 | +``` |
| 39 | + |
| 40 | +Or using `curl`: |
| 41 | + |
| 42 | +```bash |
| 43 | +bash <(curl -s https://raw.githubusercontent.com/borjapazr/dotfiles/HEAD/installer) |
| 44 | +``` |
| 45 | + |
| 46 | +### 🧸 Configuration |
| 47 | + |
| 48 | +Read [this](doc/installation-guide.md) page. |
| 49 | + |
| 50 | +## 📋 Features |
| 51 | + |
| 52 | +### ⚒️ Built with |
| 53 | + |
| 54 | +- [Oh My Zsh](https://ohmyz.sh/) Oh My Zsh is a delightful, open source, community-driven framework for managing your Zsh configuration. It comes bundled with thousands of helpful functions, helpers, plugins, themes, and a few things that make you shout... |
| 55 | +- [fzf](https://github.com/junegunn/fzf) A general-purpose command-line fuzzy finder. |
| 56 | +- [dotbot](https://github.com/anishathalye/dotbot) Dotbot is a tool that bootstraps your dotfiles (it's a [Dot]files [bo]o[t]strapper, get it?). It does less than you think, because version control systems do more than you think. |
| 57 | + |
| 58 | +### 🌚 The `dot` command |
| 59 | + |
| 60 | +`dot` is the core command my .dotfiles. If you execute it, you'll see all your scripts. |
| 61 | + |
| 62 | +```bash |
| 63 | +[mars] ~ dot -h |
| 64 | +Usage: |
| 65 | + dot |
| 66 | + dot <context> |
| 67 | + dot <context> <script> [<args>...] |
| 68 | + dot -h | --help |
| 69 | + dot -p | --print |
| 70 | +``` |
| 71 | + |
| 72 | +## 👥 Contributing |
| 73 | + |
| 74 | +Just fork and open a pull request. All contributions are welcome 🤗 |
| 75 | + |
| 76 | +## 🎯 Credits |
| 77 | + |
| 78 | +These .dotfiles are largely based on [@rgomezcasas](https://github.com/rgomezcasas) [personal .dotfiles](https://github.com/rgomezcasas/dotfiles) and the [dotly](https://github.com/CodelyTV/dotly) framework. They have been adapted to suit my personal needs. |
| 79 | + |
| 80 | +🙏 Thank you very much for these wonderful creations. |
| 81 | + |
| 82 | +### ⭐ Stargazers |
| 83 | + |
| 84 | +[](https://github.com/borjapazr/dotfiles/stargazers) |
| 85 | + |
| 86 | +## 🚩 License |
| 87 | + |
| 88 | +MIT @ [borjapazr](https://me.marsmachine.space). Please see [License](LICENSE) for more information. |
0 commit comments