Source Layout

The source code for ResumeFodder is split among four git repositories:

Git Repositories

The primary host for ResumeFodder source is on GitLab, although GitHub mirrors are also available:

Core

Command-line Front-end

Online Front-end

Templates

Cloning the Repositories

To create new templates, the ResumeFodder-templates repository is the only one you need to clone. See the "Creating Templates" section of the documentation for more detail.

ResumeFodder is written in the Go programming language, and its application repositories are meant to be cloned via the go tool. To work with the ResumeFodder command-line front-end, set the GOPATH environment variable to some workspace directory on your filesystem, and run these commands:

# Clone the git repo into your workspace
go get gitlab.com/steve-perkins/ResumeFodder-cli

# Import the templates submodule
cd $GOPATH/gitlab.com/steve-perkins/ResumeFodder-cli
git submodule init
git submodule update

# Compile. You can name the execuable whatever you like (e.g. "ResumeFodder.exe" on Windows)
go build -o ResumeFodder

Contributing

ResumeFodder is essentially "feature complete" for the time being. There are no immediate plans to add new functionality to the core processor or its front-ends. If you have a proposal for new functionality, please create an issue ticket to discuss it.

If you find a bug in ResumeFodder, then GitLab is the preferred collaboration platform for merge requests, but pull requests may be issued to the GitHub mirror also. Either way, it is best to create an issue ticket first before writing the code change.

If you would like to author a new template for ResumeFodder, then this is VERY welcomed! See the "Creating Templates" section of the documentation for more detail. If you are not comfortable adding the Go template dynamic tags yourself, then you are still encouraged to submit a resume with static text in Microsoft Word 2003 XML format.

Note that ResumeFodder is made available under the MIT License. By making any contribution, you acknowledge that the MIT License will apply to it as well.