aboutsummaryrefslogtreecommitdiff
path: root/Doom/.doom.d/modules/private/gentemplate/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'Doom/.doom.d/modules/private/gentemplate/README.org')
-rw-r--r--Doom/.doom.d/modules/private/gentemplate/README.org19
1 files changed, 19 insertions, 0 deletions
diff --git a/Doom/.doom.d/modules/private/gentemplate/README.org b/Doom/.doom.d/modules/private/gentemplate/README.org
new file mode 100644
index 0000000..c09f20e
--- /dev/null
+++ b/Doom/.doom.d/modules/private/gentemplate/README.org
@@ -0,0 +1,19 @@
+#+TITLE: private/gentemplate
+#+DATE: March 17, 2020
+
+* Description
+This module allows users to clone templates from my Github to specific machines.
+These templates allow for quick and easy setup for languages or frameworks where
+this sort of thing isn't very nice to do (for example C++).
+
+This module is used through the main function =+gentemplate/generate-template=.
+It will ask what template you want to use then where to put it, finally doing
+the necessary work to get you that template. You may mutate the variables
+=+gentemplate/template-list= and =+gentemplate/profile-url= to customise your
+templates.
+* Prerequisites
+- git
+* Requirements
+- ivy
+- magit
+- cl