https://github.com/michaelcurrin/generic-project-template

Starter template for a project in any programming language - including docs, Makefile, and GH Actions CI
https://github.com/michaelcurrin/generic-project-template

base documentation-template generic github-actions quickstart starter template

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/michaelcurrin/generic-project-template
• Owner: MichaelCurrin
• License: mit
• Created: 2021-01-30T14:57:37.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-12-04T16:52:47.000Z (about 4 years ago)
• Last Synced: 2025-02-01T17:11:13.092Z (11 months ago)
• Topics: base, documentation-template, generic, github-actions, quickstart, starter, template
• Language: Makefile
• Homepage: https://michaelcurrin.github.io/generic-project-template/
• Size: 394 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://michaelcurrin.github.io/badge-generator/)._

[![Placeholder CI](https://github.com/MichaelCurrin/generic-project-template/workflows/Placeholder%20CI/badge.svg)](https://github.com/MichaelCurrin/generic-project-template/actions?query=workflow:"Placeholder+CI" "Go GitHub Actions workflow")

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/generic-project-template?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/generic-project-template/releases/ "Go to GitHub releases")

[![License](https://img.shields.io/badge/License-MIT-blue)](#license "Go to license section")

_TODO: Add badges here to show your project was made with Python, Node, Go, etc. Copy from Badge Generator [Catalogue](https://michaelcurrin.github.io/badge-generator/#/catalogue)._

## How to use this starter project



[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/generic-project-template/generate)



See the [Template Notes](/docs/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._



    

        

    








[![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-2ea44f?style=for-the-badge)](https://michaelcurrin.github.io/generic-project-template/)



## 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._

```sh

$ foo-bar --help

```

```sh

$ 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](/Makefile) - this is aimed at macOS and Linux users._



[![View - Online docs](https://img.shields.io/badge/View-Online_docs-blue?style=for-the-badge)](https://michaelcurrin.github.io/generic-project-template/ "Go to online documentation")



_If you don't want a docs site, you can just link to your docs directory_.



[![View - Documentation](https://img.shields.io/badge/View-Documentation-blue?style=for-the-badge)](/docs/ "Go to documentation directory")



## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).