README
¶
gogen
Go Generator: a template generator written in Go.
Developed for the purpose of easily generate new text files, based on predefined templates.
This was developed to remove slightly repetitive work when doing new homework assignments at university by having to copy the same template LaTeX files around.
Installation
In order to install this program you need to have the go tools installed. You can look into downloading and installing those here.
make install
This installs the compiled binary in your GOBIN folder. This folder needs to be in your $PATH environmental variable, and it needs to be set with the command go env -w GOBIN=<path>
Usage
When installed, the gogen binary should be available to use.
TODO: Write a nice section later...
For developers
You need the GNU tool make in order to use the predefined features of the Makefile.
Build the binary
make build
Produces the gogen binary file in the root of the source folder.
Run without compiling
make run [ARGS]
This uses the go run command and passes the args to the program.
Remove the binary from the root folder in the source directory
make clean
This removes the binary file that was created with make build
Roadmap
This roadmap shows the different features that I'd like to implement as time goes on
Implement CRUD operations on the template entries
- List all template entries
- Create a new template entry
- Edit a template entry
- Delete a template entry
Note: this might be a pain in the rear, so I am unsure if this has highest priority.
Implement nested template files
This allows the user to nest templates such that one can give a series of names to gogen such that the user can group together related files
Implement variables to fill out templates
Implement various $NAME variables for the user to use in their template. On top of my head I can think of:
- Todays date
- OS type (macOS, Linux, Windows)
- Perhaps some user defined ones that could be stored in the YAML file
Unit tests
We need to write tests for this...
Directories