Skip to content

Instantly share code, notes, and snippets.

@Matticusau

Matticusau/README-Template.md

Last active March 21, 2017 01:20
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Matticusau/58b925d4aebc34946496eca3e8057a12 to your computer and use it in GitHub Desktop.
Save Matticusau/58b925d4aebc34946496eca3e8057a12 to your computer and use it in GitHub Desktop.
Download ZIP
A README.md template that I use for my repositories to simplify development environment setup
Raw
README-Template.md

ProjectName

A description of the project

System Requirements

  • WMF (PowerShell) 5.0
  • Windows Server 2012 R2, Windows 10 or greater

Required PowerShell Modules

The following PowerShell modules.

  • Microsoft.PowerShell.Archive
  • ActiveDirectory
  • SqlServer

Example

The following example demonstrates how to run this tool

Command goes here

Versions

This project uses SemVer for versioning. While the following is an overview of the offical releases, for the detailed versions available, see the tags on this repository.

Unreleased

  • None

1.0.0.0

  • Initial push

I found a bug

Create an issue through GitHub and lets work on solving it together :)

Contributing

If you are interested in contributing please check out common DSC Resources contributing guidelines. These are the standards I try and adopt for ALL of my work as well.

Dev Tools

The following development tools have been used when authoring this project.

  • VSCode
  • VSCode Extensions - C#, , mssql, PowerShell, vscode-icons
  • PowerShell 5.0
  • Git

Setting up your Dev environment

The following actions need to be taken if you wish to contribute

  1. Install VSCode
  2. Install PowerShell 5.0
  3. Install the VSCode Extensions - C#, mssql, PowerShell, vscode-icons
  4. Configure the extensions, for example set your icons (File > Preferences) to vscode-icons
  5. Clone this repository
  6. Create a branch for your work

License

This project is released under the GNU General Public License 3.0 This project is released under the MIT License

Contributors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment