Skip to content

Instantly share code, notes, and snippets.

@DomPizzie

DomPizzie/README-Template.md

Last active October 26, 2025 12:55
Show Gist options
  • Save DomPizzie/7a5ff55ffa9081f2de27c315f5018afc to your computer and use it in GitHub Desktop.
Save DomPizzie/7a5ff55ffa9081f2de27c315f5018afc to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. DomPizzie revised this gist Sep 4, 2018. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -58,4 +58,5 @@ Inspiration, code snippets, etc.
    * [awesome-readme](https://github.com/matiassingers/awesome-readme)
    * [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
    * [dbader](https://github.com/dbader/readme-template)
    * [zenorocha](https://gist.github.com/zenorocha/4526327)
    * [zenorocha](https://gist.github.com/zenorocha/4526327)
    * [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
  2. Dominique Pizzie revised this gist Mar 28, 2017. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -37,7 +37,7 @@ command to run if program contains helper info

    Contributors names and contact info

    ex. Dominique Pizzie
    ex. Dominique Pizzie
    ex. [@DomPizzie](https://twitter.com/dompizzie)

    ## Version History
  3. Dominique Pizzie revised this gist Mar 28, 2017. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -29,15 +29,15 @@ code blocks for commands
    ## Help

    Any advise for common problems or issues.
    ```PowerShell
    ```
    command to run if program contains helper info
    ```

    ## Authors

    Contributors names and contact info

    ex. Dominique Pizzie
    ex. Dominique Pizzie
    ex. [@DomPizzie](https://twitter.com/dompizzie)

    ## Version History
  4. Dominique Pizzie revised this gist Mar 28, 2017. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -4,7 +4,7 @@ Simple overview of use/purpose.

    ## Description

    A in-depth paragraph about your project and overview of use.
    An in-depth paragraph about your project and overview of use.

    ## Getting Started

  5. Dominique Pizzie created this gist Mar 28, 2017.
    61 changes: 61 additions & 0 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,61 @@
    # Project Title

    Simple overview of use/purpose.

    ## Description

    A in-depth paragraph about your project and overview of use.

    ## Getting Started

    ### Dependencies

    * Describe any prerequisites, libraries, OS version, etc., needed before installing program.
    * ex. Windows 10

    ### Installing

    * How/where to download your program
    * Any modifications needed to be made to files/folders

    ### Executing program

    * How to run the program
    * Step-by-step bullets
    ```
    code blocks for commands
    ```

    ## Help

    Any advise for common problems or issues.
    ```PowerShell
    command to run if program contains helper info
    ```

    ## Authors

    Contributors names and contact info

    ex. Dominique Pizzie
    ex. [@DomPizzie](https://twitter.com/dompizzie)

    ## Version History

    * 0.2
    * Various bug fixes and optimizations
    * See [commit change]() or See [release history]()
    * 0.1
    * Initial Release

    ## License

    This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

    ## Acknowledgments

    Inspiration, code snippets, etc.
    * [awesome-readme](https://github.com/matiassingers/awesome-readme)
    * [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
    * [dbader](https://github.com/dbader/readme-template)
    * [zenorocha](https://gist.github.com/zenorocha/4526327)