Skip to content

Instantly share code, notes, and snippets.

@sigustin

sigustin/Portfolio-Item-README-template.md

Last active February 24, 2019 20:35
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sigustin/9449664c56a974b5b3df28ba8160317b to your computer and use it in GitHub Desktop.
Save sigustin/9449664c56a974b5b3df28ba8160317b to your computer and use it in GitHub Desktop.
Download ZIP
Template of a README for projects intended to be linked into a software engineering portfolio
Raw
Portfolio-Item-README-template.md

Project's name

Precise description of the project (potentially including which course it was made for).

Languages used:

  • list of used languages

Collaborators

Who I made this project with

What I learned

  • List of things I learned while making this project

Files worth checking out

Compilation and execution

Compile the project:



Run the project:




Run the tests:





  


  





      
      

        

          

            









          


          

            

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