Generic Project Template

Starter template for a project in any programming language - including docs, Makefile, and GH Actions CI

TODO: Generate more badges with Badge Generator.

TODO: Add badges here to show your project was made with Python, Node, Go, etc. Copy from Badge Generator Catalogue.

How to use this starter project

See the Template Notes part of the docs for more info.

Preview

TODO: This is the docs site part as that's all there is. You could use a screenshot of your website, or of sample input and output in the CLI or a scripting language.

Sample usage

TODO: Add just a few lines to show how to use your application. Such as an Python/Node interpreter snippet or shell snippet.

$ foo-bar --help

$ make install
$ make run

Documentation

This is template project doesn't actually run any code, but it comes with a minimal docs site with some placeholder values linked below. Mostly using make commands for the Makefile - this is aimed at macOS and Linux users.

If you don't want a docs site, you can just link to your docs directory.

License

Released under MIT by @MichaelCurrin.