This project is a template for a shell around an open source project. This about section should be replaced with some text that describes what your project does.
Sections in this readme that are marked with italics require review and action when utilizing the template. Additional sections may be added.
Generally speaking, the LICENSE.txt file, Contributing, and License sections should be left alone. The CONTRIBUTORS.md, CONTRIBUTING.md, and NOTICE.txt should be left in place but may need to be enhanced with additional details, and signed with initial contributor names.
This usage section should be removed or replaced with details around the usage of your project. As a library and/or an independent functional piece of software.
Describe how to build and test your project here. This can serve as a guideline for potentially contributors reducing questions about how to build and test your project. Additionally it can cut back on the number of pull requests you may receive that start failing tests and keep your project from building.
Artifacts or running software associated with this project and where to access them is generally added here.
In the open source community provided pre-built artifacts for your project can greatly assist in adoption and building good will.
Define testing, code conventions, and code formatting standards for the project. If no such standards are desired, please remove this section.
Define how consumers and contributors should communicate with others on the project. This may include information from mailing lists to where bugs are logged. Github issues are a great way to track bugs and enhancements with the project. You may think about conventions that you'd like issues that are logged to follow. For example, noting an enhancement vs a bug.
See CONTRIBUTING.md
Copyright 2016 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.