From 059c4ae791a8c8b13be3842143e09522494d868e Mon Sep 17 00:00:00 2001 From: Sean Breckenridge Date: Thu, 10 Feb 2022 17:01:39 -0800 Subject: [PATCH] docs: add link to template --- README.org | 1 + doc/MODULE_DESIGN.org | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 184c250..865ca42 100644 --- a/README.org +++ b/README.org @@ -723,6 +723,7 @@ Other HPI Repositories: - [[https://github.com/seanbreckenridge/HPI][seanbreckenridge/HPI]] - [[https://github.com/madelinecameron/hpi][madelinecameron/HPI]] +If you want to create your own to create your own modules/override something here, you can use the [[https://github.com/seanbreckenridge/HPI-template][template]]. * Related links :PROPERTIES: diff --git a/doc/MODULE_DESIGN.org b/doc/MODULE_DESIGN.org index 721dea8..d51b677 100644 --- a/doc/MODULE_DESIGN.org +++ b/doc/MODULE_DESIGN.org @@ -127,7 +127,7 @@ If you install both directories as editable packages (which has the benefit of a There is no limit to how many directories you could install into a single namespace package, which could be a possible way for people to install additional HPI modules, without worrying about the module count here becoming too large to manage. -There are some other users [[https://github.com/hpi/hpi][who have begun publishing their own modules]] as namespace packages, which you could potentially install and use, in addition to this repository, if any of those interest you. +There are some other users [[https://github.com/hpi/hpi][who have begun publishing their own modules]] as namespace packages, which you could potentially install and use, in addition to this repository, if any of those interest you. If you want to create your own you can use the [[https://github.com/seanbreckenridge/HPI-template][template]] to get started. Though, enabling this many modules may make ~hpi doctor~ look pretty busy. You can explicitly choose to enable/disable modules with a list of modules/regexes in your [[https://github.com/karlicoss/HPI/blob/f559e7cb899107538e6c6bbcf7576780604697ef/my/core/core_config.py#L24-L55][core config]], see [[https://github.com/seanbreckenridge/dotfiles/blob/a1a77c581de31bd55a6af3d11b8af588614a207e/.config/my/my/config/__init__.py#L42-L72][here]] for an example.