Skip to content

Instantly share code, notes, and snippets.

@r4dixx

r4dixx/README-STUDENT.md

Last active March 26, 2024 16:49
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 6 You must be signed in to fork a gist
  • Save r4dixx/43e51e7d59027b26fefec2b389fc9e53 to your computer and use it in GitHub Desktop.
Save r4dixx/43e51e7d59027b26fefec2b389fc9e53 to your computer and use it in GitHub Desktop.
Download ZIP
Readme template for student projects
Raw
README-STUDENT.md

Name

Description
Comment


About

Context and progress go here

Goal and requirements

The idea behind first implementation. What is expected, what should be included, what should not be included.

Key learnings

  • Be
  • clear
  • brief
  • and
  • concise

If project has been improved after submission, here is a good place to specify it.

Installation

  1. Download this project as zip and extract it
  2. Import it in Android Studio
  3. Sync Gradle and run on your device/emulator

Or use dryrun by @CesarFerreira

Contributing

Mention pull requests. Link to an example and/or put it down here

Project status

Insert here

Credits

Copyright

This project is licensed under the terms of the MIT license and protected by Udacity Honor Code and Community Code of Conduct. See license and disclaimer.
@W1zarDddD
Copy link

W1zarDddD commented Nov 28, 2023 •
edited

I come across read me files very often. I'm studying to be a web developer and this is common. This also appears in the documents. If I didn’t understand something at some point, I used a writing service and found an essay service for this. This is a common occurrence. In principle, it is designed the same as in the example.

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