Skip to content

A nushell-driven dotfiles for a desktop configuration named "lovemii" (pronounced "love me").

License

Notifications You must be signed in to change notification settings

BeyondMagic/desktop

Repository files navigation

lovemii: A nushell-driven dotfiles collection to configure a personalized desktop environment (Hyprland, apps, services) for fast, reproducible setup.

Requirements

  • A linux distribution with dinit as init system and pacman as package manager.
  • Intermediate knowledge of unix-like systems and desktop environments.
  • Basic knowledge of git.

Setup

Configuration

You can find explanations for each option inside the config.example.toml file. You should read and make a copy of this file named config.toml and edit it to your needs before running the setup.

Quickstart

  1. Install nushell, then run the following:
$ git clone https://github.com/BeyondMagic/desktop ~/projects/desktop
$ cd ~/projects/desktop
  1. Extend the sys module:
$ use sys.nu
  1. Read and understand the sys module:
$ sys --help
  1. Copy the example configuration file and edit it to your needs:
$ cp config.example.toml config.toml
  1. Open the configuration file and run the setup function, which will install and configure everything interactively:
$ open config.toml | sys setup

Usage

After the setup is complete, you can use the sys command to manage your desktop environment.

  • To update your configuration, run:
$ sys update

Troubleshooting

If you encounter any issues during the setup or usage of this project, please refer to the Issues section of the repository. You can also open a new issue if your problem is not listed.

Principles

  1. lovemii is, generally speaking, multipurposed. It includes features which you really need to set up a desktop environment, but also features which are nice to have.

  2. lovemii is designed to be as modular as possible. You can enable or disable features in the configuration file.

  3. User experience is a priority, second only to performance. The setup process is interactive and guides you through the configuration.

Contributing

Contribution guidelines.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Maintained solely by beyondmagic.

About

A nushell-driven dotfiles for a desktop configuration named "lovemii" (pronounced "love me").

Topics

Resources

License

Contributing

Stars

Watchers

Forks