Skip to content

Instantly share code, notes, and snippets.

@luisjunco

luisjunco/readme-project-1.md

Last active November 23, 2023 17:49
Show Gist options
  • Save luisjunco/b926ab518536365b729ea3fd8f4531b1 to your computer and use it in GitHub Desktop.
Save luisjunco/b926ab518536365b729ea3fd8f4531b1 to your computer and use it in GitHub Desktop.
Download ZIP
Requirements README project 1
Raw
readme-project-1.md

README Project 1

  • Description

    • Brief description of the project
    • You can also add screenshots 🤩

  • Instructions to play

    • Important: make sure that anyone with the link can play your game (if it is not trivial, include also instructions in the game itself)

  • Demo

    • Link where users can see the final version of your project (github pages)

How to create your README file

  • If you create/edit your readme directly on GitHub (on the browser), it will create a commit on GitHub... and we still haven't seen how to integrate that with our own commits ⚠️
  • To avoid this, the best option for now is to create your README file from VS Code (create a file README.md) + commit + push ✔️

Resources

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