Skip to content

Commit

Permalink
Update package descriptions in PKGBUILD and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ulises-jeremias committed Apr 6, 2024
1 parent d9a2542 commit 32b7a97
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 12 deletions.
2 changes: 1 addition & 1 deletion PKGBUILD
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
pkgname=dots-stable
pkgver=1.2.2
pkgrel=1
pkgdesc="Dotfiles generator that allows quick configuration and managing of different tools and window managers in multiple OSs"
pkgdesc="HorneroConfig - Comprehensive Dotfiles Framework"
arch=(any)
url="https://github.com/ulises-jeremias/dotfiles"
license=('MIT')
Expand Down
2 changes: 1 addition & 1 deletion PKGBUILD.dev
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
pkgname=dots-git
pkgver=1.2.2
pkgrel=1
pkgdesc="Dotfiles generator that allows quick configuration and managing of different tools and window managers in multiple OSs"
pkgdesc="HorneroConfig - Comprehensive Dotfiles Framework"
arch=(any)
url="https://github.com/ulises-jeremias/dotfiles"
license=('MIT')
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
NEVER SKIP / IGNORE / AVOID README
```

<h1>🔥 Dotfiles Generator</h1>
<h1>🏠 HorneroConfig - Comprehensive Dotfiles Framework</h1>

[Docs](https://ulises-jeremias.github.io/dotfiles) |
[Changelog](#) |
Expand Down Expand Up @@ -34,14 +34,22 @@ NEVER SKIP / IGNORE / AVOID README
You might be here looking for (Linux) rice reference or to (full?) replicate my personal
configuration of my favorite Window Managers and several apps as well. ⛄

These configuration is not only suitable for Desktop Environments but also for use in [GitHub Codespaces](https://docs.github.com/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles), [Gitpod](https://www.gitpod.io/docs/config-dotfiles), [VS Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers#_personalizing-with-dotfile-repositories), or even Linux distributions that are not Arch Linux.
HorneroConfig is your artisanal toolkit for crafting the perfect digital workspace.
Named after the industrious hornero bird, renowned for its skillful nest-building,
our framework empowers you to construct a robust, functional, and personalized computing environment.

This dotfiles are backed by [Chezmoi](https://www.chezmoi.io/) which is a dotfiles manager that is designed to be flexible and extensible. It is easy to bootstrap new machines and keep multiple machines in sync. It supports any platform that is supported by Go!
Perfectly suited for a wide array of Desktop Environments and Window Managers,
HorneroConfig thrives across different platforms including [GitHub Codespaces](https://docs.github.com/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles), [Gitpod](https://www.gitpod.io/docs/config-dotfiles), [VS Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers#_personalizing-with-dotfile-repositories), or even Linux distributions that are not Arch Linux.

Backed by the versatile [Chezmoi](https://www.chezmoi.io/), HorneroConfig stands out as a dotfiles manager
that adapts flexibly to your needs, streamlining machine setup and ensuring consistency across devices.
Embrace the spirit of the hornero, and let HorneroConfig transform your configurations
into a harmonious blend of elegance and efficiency.

<div align="center">

```ocaml
CLICK OR TAP ❲☰❳ TO SHOW TABLE-OF-CONTENTS
TAP ❲☰❳ TO NAVIGATE THE HARMONY OF CONFIGURATION
```

</div>
Expand Down Expand Up @@ -89,7 +97,7 @@ This will install the dotfiles in `~/.dotfiles`.
### Using Chezmoi
> This is a recommended way to install the dotfiles generator. It will install the latest stable version of the dotfiles generator using [Chezmoi](https://www.chezmoi.io/) which is a dotfiles manager that is designed to be flexible and extensible.
> This is the recommended method to install HorneroConfig. It will set up the latest stable version of HorneroConfig on your system using [Chezmoi](https://www.chezmoi.io/), a robust and adaptable dotfiles manager. With Chezmoi, you can easily manage your configuration files across multiple machines, maintaining consistency and simplifying the setup process.
```sh
chezmoi init --apply ulises-jeremias --source ~/.dotfiles
Expand All @@ -100,7 +108,7 @@ This will install the dotfiles in `~/.dotfiles`.
### From source

> Use this for any OS that is not `Arch Linux` or `Arch Linux based distro`.
> This will install unstable versions of the dotfiles generator. You can switch to a stable version by using any existing git tag.
> This will install unstable versions of HorneroConfig. You can switch to a stable version by using any existing git tag.
```sh
git clone https://github.com/ulises-jeremias/dotfiles ~/.dotfiles
Expand Down Expand Up @@ -176,7 +184,7 @@ You can read more about this at [Privacy and Security Docs](https://ulises-jerem

## 🧪 Testing

We use [Vagrant](https://www.vagrantup.com/) to test the installation of the dotfiles generator in different
We use [Vagrant](https://www.vagrantup.com/) to test the installation of HorneroConfig in different
Operating Systems and machine architectures.

<details>
Expand Down
14 changes: 11 additions & 3 deletions docs/Home.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<h1>🚀 Dotfiles Generator</h1>
<h1>🏠 HorneroConfig - Comprehensive Dotfiles Framework</h1>

[Docs](https://ulises-jeremias.github.io/dotfiles) |
[Changelog](#) |
Expand All @@ -19,9 +19,17 @@
You might be here looking for (Linux) rice reference or to (full?) replicate my personal
configuration of my favorite Window Managers and several apps as well. ⛄

These configuration is not only suitable for Desktop Environments but also for use in [GitHub Codespaces](https://docs.github.com/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles), [Gitpod](https://www.gitpod.io/docs/config-dotfiles), [VS Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers#_personalizing-with-dotfile-repositories), or even Linux distributions that are not Arch Linux.
HorneroConfig is your artisanal toolkit for crafting the perfect digital workspace.
Named after the industrious hornero bird, renowned for its skillful nest-building,
our framework empowers you to construct a robust, functional, and personalized computing environment.

This dotfiles are backed by [Chezmoi](https://www.chezmoi.io/) which is a dotfiles manager that is designed to be flexible and extensible. It is easy to bootstrap new machines and keep multiple machines in sync. It supports any platform that is supported by Go!
Perfectly suited for a wide array of Desktop Environments and Window Managers,
HorneroConfig thrives across different platforms including [GitHub Codespaces](https://docs.github.com/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles), [Gitpod](https://www.gitpod.io/docs/config-dotfiles), [VS Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers#_personalizing-with-dotfile-repositories), or even Linux distributions that are not Arch Linux.

Backed by the versatile [Chezmoi](https://www.chezmoi.io/), HorneroConfig stands out as a dotfiles manager
that adapts flexibly to your needs, streamlining machine setup and ensuring consistency across devices.
Embrace the spirit of the hornero, and let HorneroConfig transform your configurations
into a harmonious blend of elegance and efficiency.

Most were written from scratch. Some details:

Expand Down

0 comments on commit 32b7a97

Please sign in to comment.