aboutsummaryrefslogtreecommitdiff
path: root/doom.d/modules/private/gentemplate/README.org
diff options
context:
space:
mode:
authorodave <aryadevchavali1@gmail.com>2020-03-17 17:03:10 +0000
committerodave <aryadevchavali1@gmail.com>2020-03-17 17:03:10 +0000
commit9ced0a3677eb55120e71a4c1bf652ea24aadf272 (patch)
tree7cfc590965f180dce756dcc8112540bda0d3ebef /doom.d/modules/private/gentemplate/README.org
parent110cf1b5f31552b2ef7cfb42b11acf3d31773a9e (diff)
downloaddotfiles-9ced0a3677eb55120e71a4c1bf652ea24aadf272.tar.gz
dotfiles-9ced0a3677eb55120e71a4c1bf652ea24aadf272.tar.bz2
dotfiles-9ced0a3677eb55120e71a4c1bf652ea24aadf272.zip
~gentemplate.org -> gentemplate module
Gentemplate is one of those things that just makes sense as a module. Thus, converted it. I may convert a few more org files into full blown modules.
Diffstat (limited to 'doom.d/modules/private/gentemplate/README.org')
-rw-r--r--doom.d/modules/private/gentemplate/README.org21
1 files changed, 21 insertions, 0 deletions
diff --git a/doom.d/modules/private/gentemplate/README.org b/doom.d/modules/private/gentemplate/README.org
new file mode 100644
index 0000000..86e7463
--- /dev/null
+++ b/doom.d/modules/private/gentemplate/README.org
@@ -0,0 +1,21 @@
+#+TITLE: private/gentemplate
+#+DATE: March 17, 2020
+#+SINCE: {replace with next tagged release version}
+#+STARTUP: inlineimages nofold
+
+* 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