6
17
Fork
You've already forked crafted-guix
6
A community-driven channel of tools and configurations for GNU Guix!
  • Scheme 98.7%
  • Makefile 0.9%
  • Shell 0.4%
Find a file
2023年10月06日 13:07:14 +00:00
examples Fix: Bind socat to 127.0.0.1 only 2023年08月31日 18:39:51 +02:00
modules/crafted remove unused guile-spec 2023年06月24日 19:30:55 +02:00
test/crafted/config remove unused guile-spec 2023年06月24日 19:30:55 +02:00
.editorconfig editorconfig: handle makefiles 2023年07月15日 18:35:41 +02:00
.envrc add a manifest and direnv setup 2023年06月24日 13:41:34 +02:00
.guix-channel Add README.org, LICENSE, and channel configuration 2023年06月12日 16:06:16 +03:00
channels.lock.scm add a manifest and direnv setup 2023年06月24日 13:41:34 +02:00
LICENSE Add README.org, LICENSE, and channel configuration 2023年06月12日 16:06:16 +03:00
Makefile remove unused guile-spec 2023年06月24日 19:30:55 +02:00
manifest.scm remove unused guile-spec 2023年06月24日 19:30:55 +02:00
pre-inst-env add a manifest and direnv setup 2023年06月24日 13:41:34 +02:00
README.org document 'make vm' setup 2023年07月15日 17:50:40 +02:00

Crafted Guix

Overview

Welcome to Crafted Guix, a collection of tools and configurations for the GNU Guix package manager and system distribution!

The purpose of this channel is to provide new (and existing) users with a more curated experience for GNU Guix.

Goals

  • Make it easier for users to configure a modern desktop environment with Wayland and Pipewire
  • Streamline day-to-day system management tasks via helpful scripts and tools
  • Enable community members to share interesting pre-made configurations for window managers and other tools

How to Use It

> IMPORTANT NOTE: This project is just getting started and we're still figuring out the initial APIs! You will probably experience breaking changes over the first few weeks, but we hope to stabilize things as soon as possible. Watch this repo for breaking change notices!

Quick-start example

All you need to get started is `guix`!

 cd examples
 guix shell make
 make env
 make vm

This will build and launch a vm with the default configuration.

As a channel

Crafted Guix can be configured as a Guix channel in an existing Guix installation, no matter whether you use Guix as a full system distribution or as a package manager on a "foreign" distro.

The easiest way to do this is to add this repository to your ~/.config/guix/channels.scm file using the following format:

 (append (list (channel
 (name 'crafted-guix)
 (url "https://codeberg.org/SystemCrafters/crafted-guix.git")
 (branch "master")))
 %default-channels)

If you've already added some channels to your channels.scm file, just insert the channel form above into your channel list!

Once you've saved your changes, you can now use the following command to pull the crafted-guix channel into your local system:

 guix pull

You should now have access to everything that this channel offers!

Contributing

If you're interested to contribute, please do so! Here are the criteria for contributions:

  • It simplifies configuration or usage of Guix for any use case (programs, window managers, etc)
  • It shouldn't belong in the main Guix repository or Nonguix instead (programs or services that aren't directly related to Crafted

If you want to know if a particular contribution would be appropriate here, please feel free to file an issue to ask about it.

Join the Community

If you'd like to discuss GNU Guix, Crafted Guix, GNU Emacs, or other related topics, join us in our Matrix/IRC chat!

More information can be found on the Community page of the System Crafters website.

License

The code in this repository is licensed under the GNU General Public License v3.0 or greater.