Skip to content

Instantly share code, notes, and snippets.

@davidjguru
Forked from PurpleBooth/README-Template.md
Created February 18, 2018 11:50

Revisions

  1. @PurpleBooth PurpleBooth revised this gist Oct 17, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -6,7 +6,7 @@ One Paragraph of project description goes here

    These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

    ### Prerequisities
    ### Prerequisites

    What things you need to install the software and how to install them

  2. @PurpleBooth PurpleBooth revised this gist Oct 12, 2016. 1 changed file with 3 additions and 3 deletions.
    6 changes: 3 additions & 3 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -58,9 +58,9 @@ Add additional notes about how to deploy this on a live system

    ## Built With

    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga
    * [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
    * [Maven](https://maven.apache.org/) - Dependency Management
    * [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

    ## Contributing

  3. @PurpleBooth PurpleBooth revised this gist Oct 2, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -64,7 +64,7 @@ Add additional notes about how to deploy this on a live system

    ## Contributing

    Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
    Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

    ## Versioning

  4. @PurpleBooth PurpleBooth revised this gist Oct 2, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -18,7 +18,7 @@ Give examples

    A step by step series of examples that tell you have to get a development env running

    Stay what the step will be
    Say what the step will be

    ```
    Give the example
  5. @PurpleBooth PurpleBooth revised this gist Sep 11, 2015. 1 changed file with 1 addition and 3 deletions.
    4 changes: 1 addition & 3 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -64,9 +64,7 @@ Add additional notes about how to deploy this on a live system

    ## Contributing

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.
    Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

    ## Versioning

  6. @PurpleBooth PurpleBooth revised this gist Aug 28, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
    We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  7. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available see the tags on this repository.
    We use [SemVer](http://semver.org/) for the versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  8. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the versioning. For the tags available, see the [tags on this repository](https://github.com/your/project/tags).
    We use [SemVer](http://semver.org/) for the version tags available see the tags on this repository.

    ## Authors

  9. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available, see the [tags on this repository](https://github.com/your/project/tags).
    We use [SemVer](http://semver.org/) for the versioning. For the tags available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  10. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available, see the tags on this repository.
    We use [SemVer](http://semver.org/) for the version tags available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  11. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 3 additions and 3 deletions.
    6 changes: 3 additions & 3 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -66,21 +66,21 @@ Add additional notes about how to deploy this on a live system

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
    Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available, see the tags on this repository.

    ## Authors

    Names of the current team members!
    * **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)

    See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

    ## License

    This project is licensed under the MIT License - see the LICENSE file for details
    This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

    ## Acknowledgments

  12. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a Contributor Code of Conduct. By

    ## Versioning

    We use [SemVer](http://semver.io/) for the version tags available See the tags on this repository.
    We use [SemVer](http://semver.org/) for the version tags available, see the tags on this repository.

    ## Authors

  13. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -68,6 +68,10 @@ Feel free to submit pull requests and issues. If it's a particualy large PR, you

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Versioning

    We use [SemVer](http://semver.io/) for the version tags available See the tags on this repository.

    ## Authors

    Names of the current team members!
  14. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -56,7 +56,7 @@ Give an example

    Add additional notes about how to deploy this on a live system

    ## Build With
    ## Built With

    * Dropwizard - Bla bla bla
    * Maven - Maybe
  15. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -56,7 +56,7 @@ Give an example

    Add additional notes about how to deploy this on a live system

    ## Technology
    ## Build With

    * Dropwizard - Bla bla bla
    * Maven - Maybe
  16. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 6 additions and 6 deletions.
    12 changes: 6 additions & 6 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -56,18 +56,18 @@ Give an example

    Add additional notes about how to deploy this on a live system

    ## Technology

    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga

    ## Contributing

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Technology Choices

    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga

    ## Authors

    Names of the current team members!
  17. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -67,7 +67,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga
    *

    ## Authors

    Names of the current team members!
  18. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 4 additions and 11 deletions.
    15 changes: 4 additions & 11 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -64,17 +64,10 @@ Please note that this project is released with a Contributor Code of Conduct. By

    ## Technology Choices

    ### Dropwizard

    Bla bla bla

    ### Maven

    Maybe

    ### Atom

    aergaerga
    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga
    *
    ## Authors

    Names of the current team members!
  19. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 15 additions and 1 deletion.
    16 changes: 15 additions & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -62,6 +62,19 @@ Feel free to submit pull requests and issues. If it's a particualy large PR, you

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Technology Choices

    ### Dropwizard

    Bla bla bla

    ### Maven

    Maybe

    ### Atom

    aergaerga
    ## Authors

    Names of the current team members!
    @@ -76,4 +89,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail

    * Hat tip to anyone who's code was used
    * Inspiration
    * etc
    * etc

  20. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 2 additions and 3 deletions.
    5 changes: 2 additions & 3 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -64,10 +64,9 @@ Please note that this project is released with a Contributor Code of Conduct. By

    ## Authors

    Nils Adermann - <naderman@naderman.de> - <https://twitter.com/naderman> - <http://www.naderman.de><br />
    Jordi Boggiano - <j.boggiano@seld.be> - <https://twitter.com/seldaek> - <http://seld.be><br />
    Names of the current team members!

    See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project.
    See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

    ## License

  21. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 12 additions and 0 deletions.
    12 changes: 12 additions & 0 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -38,8 +38,20 @@ Explain how to run the automated tests for this system

    ### Break down into end to end tests

    Explain what these tests test and why

    ```
    Give an example
    ```

    ### And coding style tests

    Explain what these tests test and why

    ```
    Give an example
    ```

    ## Deployment

    Add additional notes about how to deploy this on a live system
  22. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 36 additions and 1 deletion.
    37 changes: 36 additions & 1 deletion README-Template.md
    Original file line number Diff line number Diff line change
    @@ -30,4 +30,39 @@ And repeat
    until finished
    ```

    End with an example of getting some data out of the system or using it for a little demo
    End with an example of getting some data out of the system or using it for a little demo

    ## Running the tests

    Explain how to run the automated tests for this system

    ### Break down into end to end tests

    ### And coding style tests

    ## Deployment

    Add additional notes about how to deploy this on a live system

    ## Contributing

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Authors

    Nils Adermann - <naderman@naderman.de> - <https://twitter.com/naderman> - <http://www.naderman.de><br />
    Jordi Boggiano - <j.boggiano@seld.be> - <https://twitter.com/seldaek> - <http://seld.be><br />

    See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project.

    ## License

    This project is licensed under the MIT License - see the LICENSE file for details

    ## Acknowledgments

    * Hat tip to anyone who's code was used
    * Inspiration
    * etc
  23. @PurpleBooth PurpleBooth created this gist Jul 21, 2015.
    33 changes: 33 additions & 0 deletions README-Template.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,33 @@
    # Project Title

    One Paragraph of project description goes here

    ## Getting Started

    These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

    ### Prerequisities

    What things you need to install the software and how to install them

    ```
    Give examples
    ```

    ### Installing

    A step by step series of examples that tell you have to get a development env running

    Stay what the step will be

    ```
    Give the example
    ```

    And repeat

    ```
    until finished
    ```

    End with an example of getting some data out of the system or using it for a little demo