Skip to content

This is a set of artifacts that an organization can use to help bootstrap and support an open source program.

License

Notifications You must be signed in to change notification settings

virtix/open-source-program-template

Repository files navigation

Open Source Program Template

This is a set of templates and artifacts intended to help organizations bootstrap an open source program.


Dependencies

  • Jekyll as the rendering and parsing engine, and

  • DOCter as the template and theme

Please refer to those sites for information on getting started and configuration. We'll address some configuration here and, where practical, will refer you to details.

Getting started

To run and edit locally

  • Ensure you have Jekyll installed
  • Clone your repo locally: git clone git@github.com:YOUR_ACCOUNT/open-source-program-template.git
  • cd into your working directory: cd open-source-program-template
  • Run Jekyll, setting the baseurl to an empty string: jekyll serve --watch --baseurl ''
  • Edit the files in the editor of your choice

License

The project is in the public domain, and all contributions to it will be released as such. By submitting a pull request, you are agreeing to waive all rights to your contribution under the terms of the CC0 Public Domain Dedication.

If you contribute the open source work of others, please mark it clearly in your pull request.

About

This is a set of artifacts that an organization can use to help bootstrap and support an open source program.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages