Skip to content

Template to create step-by-step documentation for your project's repositories on Github.

License

Notifications You must be signed in to change notification settings

binarieschool/template-readme-repos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

20 Commits
Β 
Β 
Β 
Β 

Repository files navigation

Note: If your project is not finished, let us know with a message. πŸ‘€

Warning

🚧️ THIS RESOURCE IS UNDER CONSTRUCTION !!! 🚧️

Name and cover image of the Project

Give your Readme a title and also include an image. For example: πŸ‘‡πŸ»

  • Name of my project [ Here ]
  • Cover image [ Here ]

Badges 🎫

They are badges that determine the status of the project, such as: license, versions, dependencies, testing, ...

Examples: πŸ‘‰πŸΌ Β Β  badges1 Β Β  badges2 Β Β  badges3

Note

Create your own Badges on the website: https://shields.io/

Table of Contents πŸ“‘


Description πŸ–‹οΈ

Describe the project, but briefly and concisely.

Demo πŸ’»

View project (URL)

Project images:

Β Β  URL Image ( Here )

Screenshot of a comment on a GitHub issue showing an image, added in the Markdown, of an Octocat smiling and raising a tentacle.

Project videos:

Β Β  URL Videos ( Here )


Feactures πŸ’‘

Briefly explain the features of your project.

Name How does it work?
Feacture 1 This feature makes...
Feacture 2 This feature makes...
Feacture 3 This feature makes...
Feacture 4 This feature makes...

Note

You can use: Images, videos, gifs, pieces of code, ...


Install and Run βš™οΈ

Project installation:

# Step 1
# Step 2

Run the project:

# Step 3
# Step 4

Download resources:

Host Type Content URL
Dropbox Images Different images of musical groups https://name-host
Dropbox Images Images of technologies https://name-host

Testing πŸ”¬

We can put some tests that we have carried out in our project to verify that everything works correctly.

Example: On the official Node page.

The node:test module facilitates the creation of JavaScript tests. To access it:

const test = require('node:test');

Built with πŸ—οΈ

Technologies to build this project:

Name Version
HTML5 1.X
CSS3 1.X
JavaScript 1.X
NodeJS 1.X
React 1.X
Python 1.X

Some code blocks from the project:

<!-- HTML -->
<!DOCTYPE html>
<html>
  <head>
    <title>Title</title>  
    <meta charset="UTF-8">
  </head>
  <body>
    <h1>Hello, World!</h1>
  </body>
</html>

{/* React */}
import React from 'react';

function App() {
  return (
    <div>
      <h1>Hello, World!</h1>
    </div>
  );
}

export default App;

# Python
print("Hello, World!")

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.


Useful resources πŸ”§

1 URL - When I was building the project I found an interesting URL.
+1 URLS When I was building the project I found some interesting URLs:

URL What does it provide?
Dropbox plugins/dropbox/README.md
GitHub plugins/github/README.md
Google Drive plugins/googledrive/README.md
OneDrive plugins/onedrive/README.md
Medium plugins/medium/README.md
Google Analytics plugins/googleanalytics/README.md

Code of conduct 🀝

Create a code of conduct if required, usually this is when your project has many collaborators. πŸ‘‡πŸ»

Example: ...


License πŸ“‹

Introduce a license to your project and briefly describe it. πŸ‘‡πŸ»

Free software license used to protect the rights of users and promote freedom in the use, modification and distribution of software.

Example: GPL-3.0 license


Author πŸ§‘πŸ»β€πŸ’»

Author or Authors or Collaborators of the project. πŸ‘‡πŸ»

Example: Melquiades H.R.

About

Template to create step-by-step documentation for your project's repositories on Github.

Topics

Resources

License

Stars

Watchers

Forks