# -*- mode: org; coding: utf-8; -*-

#+TITLE: README for Guix-Cantrips

Utilities to make programming with guix feel like ~magic~.

* Install

Currently, the only way to install is with guix. Add this repo as a channel to your channels.scm:

#+BEGIN_SRC scheme
	(channel
	 (name 'guix-cantrips)
	 (url "https://git.solarpunk.moe/TakeV/guix-cantrips.git")
	 (branch "main")
	 (introduction
		(make-channel-introduction
		 "eae81890ad657de402acd7e2013f4f02376a7bf0"
		 (openpgp-fingerprint "1086 326D E207 068C 1C02  5129 A64F 4134 5C74 00AF"))))
#+END_SRC

Then run =guix pull= followed by =guix install guix-cantrips=.

* Usage
Invoke with =guix-cantrips COMMAND=.

* Utilities
The current utilities include:

| Utility | Description                                                                                                    |
|---------+----------------------------------------------------------------------------------------------------------------|
| summon  | Downloads the source code of the specified package, and extracts it to a project directory (~/src by default). |
|         | *Please note that this can overwrite the folder in the project directory, should the project already exist.*     |