From da2e8790faf5d6035fcc83c7ebbf2fd53bff86d3 Mon Sep 17 00:00:00 2001 From: Anselm Bradford Date: Fri, 10 Apr 2015 14:06:01 -0400 Subject: [PATCH] Fixes #13 - adds INSTALL.md - Fixes #13 - adds INSTALL.md --- CONTRIBUTING.md | 16 ++++++++-------- INSTALL.md | 3 +++ README.md | 18 +++++++++--------- 3 files changed, 20 insertions(+), 17 deletions(-) create mode 100644 INSTALL.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61226f1..059f2ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,24 @@ # Guidance on how to contribute > All contributions to this project will be released under the CC0 public domain -> dedication. By submitting a pull request or filing a bug, issue, or +> dedication. By submitting a pull request or filing a bug, issue, or > feature request, you are agreeing to comply with this waiver of copyright interest. > Details can be found in our [TERMS](TERMS.md) and [LICENCE](LICENSE). -There are two primary ways to help: - - Using the issue tracker, and +There are two primary ways to help: + - Using the issue tracker, and - Changing the code-base. ## Using the issue tracker -Use the issue tracker to suggest feature requests, report bugs, and ask questions. +Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well -as others who are interested in this solution. +as others who are interested in this solution. Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in -the issue that you will take on that effort, then follow the _Changing the code-base_ +the issue that you will take on that effort, then follow the _Changing the code-base_ guidance below. @@ -26,7 +26,7 @@ guidance below. Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull-request. All new code should have associated unit -tests that validate implemented features and the presence or lack of defects. -Additionally, the code should follow any stylistic and architectural guidelines +tests that validate implemented features and the presence or lack of defects. +Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of such guidelines, mimic the styles and patterns in the existing code-base. diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..4c199e6 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,3 @@ +# Installation instructions + +Detailed instructions on how to install, configure, and get the project running. diff --git a/README.md b/README.md index 6d1289d..529df61 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 4. Add any libraries, assets, or hard dependencies whose source code will be included in the project's repository to the _Exceptions_ section in the [TERMS](TERMS.md). - If no exceptions are needed, remove that section from TERMS. -5. If working with an existing code base, answer the questions on the [open source checklist](opensource-checklist.md) +5. If working with an existing code base, answer the questions on the [open source checklist](opensource-checklist.md) 6. Delete these instructions and everything up to the _Project Title_ from the README. 7. Write some great software and tell people about it. @@ -17,7 +17,7 @@ # Project Title **Description**: Put a meaningful, short, plain-language description of what -this project is trying to accomplish and why it matters. +this project is trying to accomplish and why it matters. Describe the problem(s) this project solves. Describe how this software can improve the lives of its audience. @@ -36,15 +36,15 @@ Other things to include: ## Dependencies -Describe any dependencies that must be installed for this software to work. +Describe any dependencies that must be installed for this software to work. This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth. -If specific versions of other software are required, or or known not to work, call that out. +If specific versions of other software are required, or known not to work, call that out. ## Installation Detailed instructions on how to install, configure, and get the project running. -This should be frequently tested to ensure reliability. Alternatively, a link to -another page is fine, but it's important that this works. +This should be frequently tested to ensure reliability. Alternatively, link to +a separate [INSTALL](INSTALL.md) document. ## Configuration @@ -52,8 +52,8 @@ If the software is configurable, describe it in detail, either here or in other ## Usage -Show users how to use the software. -Be specific. +Show users how to use the software. +Be specific. Use appropriate formatting when showing code snippets. ## How to test the software @@ -95,4 +95,4 @@ General instructions on _how_ to contribute should be stated with a link to [CON 1. Projects that inspired you 2. Related projects -3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project +3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project