Skip to content

Documentation templates for use in open source and open development projects

License

Apache-2.0 and 3 other licenses found

Licenses found

Apache-2.0
LICENSE
Unknown
COPYING.txt
MIT
LICENSE-MIT
OSL-3.0
LICENSE-OSL
Notifications You must be signed in to change notification settings

irenelagno/starter-repo

 
 

Open Source Starter Repo

This repository contains templates for project documentation, ensuring necessary legal and contributor documentation is explicit. All sections below in this README.md should be considered a template for a typical project README.md.

PROJECT NAME

A short description of what this project does.

Goals

It is a good idea to provide a mission statement for your project, enshrining what the project wants to accomplish so that as more people join your project everyone can work in alignment.

Non-Goals

It is also a good idea to declare what are not goals of the project to prevent potential feature creep.

Installation

Instructions for how to download/install the code onto your machine.

Example:

npm install myProject --save

Usage

Usage instructions for your code.

Example:

var myMod = require('mymodule');

myMod.foo('hi');

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

About

Documentation templates for use in open source and open development projects

Resources

License

Apache-2.0 and 3 other licenses found

Licenses found

Apache-2.0
LICENSE
Unknown
COPYING.txt
MIT
LICENSE-MIT
OSL-3.0
LICENSE-OSL

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published