Skip to content
This repository was archived by the owner on Aug 14, 2018. It is now read-only.
/ essential-files Public archive

Essential files to include to comply with TrustOSS specification. See releases for archive downloads.

License

Notifications You must be signed in to change notification settings

trustoss/essential-files

Repository files navigation

Project NAME

Build Status Badge - Use something like TravisCI

Brief explanation of the project.

Table of Contents

Installation

Installation details should include local installation steps, and steps to deploy for end users (if applicable)

Basic Usage Install

This is what the average visitor would need to do to install your application.

Production Deployment

This is what a project implementor or partner (read: devops) would need to do to deploy your application in production (if applicable).

Development Install

This is what a project contributor would need to do to install your application locally.

Usage / API

This should outline the basic and advanced usage of your application, and a complete API reference (if applicable)

Troubleshooting

This section is a work in progress. Troubleshooting issues and solutions will be posted here as they are raised.

FAQs

This section is a work in progress. FAQs will be posted here as they are raised.

Team

List of core team members here (optional)

Contact

The main method to contact the project lead, whether by email, Slack, IRC, carrier pidgeon or smoke signal.

Feel free to chat with the PROJECT core team (and many other users) on IRC in the #project channel on Freenode, or via email on the Project mailing list.

Additional Resources

About

Essential files to include to comply with TrustOSS specification. See releases for archive downloads.

Resources

License

Stars

Watchers

Forks

Packages

No packages published