A Brief Description: References, Markdown, Icons to make README.md file much, much cooler.
Logo ou Banner | Project's Name | Description and motivation | Index | About README and MarkDown | Badges | Visuals and Screenshots | Technologies | Installation and Features | Usage | Project's status | Issues | Contributions | Authors and acknowledgment | References | License
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short.
If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. This is a suggested structure, each one can do according to the needs of the project. We will now cover each of the structure's topics and other additional points.
Markdown is a text to HTML conversion tool. You write using simple, easy-to-read and easy-to-write text and then it is transformed into valid HTML.
Markdown was created by John Gruber and Aaron Swartz and their source code was written in Perl. This is the official website here
It is possible to view and create MarkDown indexes within VS Code by adding an extension:
| Shortcuts | Functionality |
|---|---|
| cmd-k v or ctrl-k | Open preview to the Side |
| cmd-shift-v or ctrl-shift-v | Open preview |
In addition, the creation of tables by sites such as:
Status: Optional
If your project already has a logo add it to the README. It can be a banner too. You can create a logo or banner using Canva.
The logo or banner may replace the title, but not the description of the project. The good thing about keeping the title and description in text is that it helps with Github SEO, Google will help to better index your project on the first pages of searches, in addition to giving a summary about your project.
Status: Required
Choose a short, self-explanatory name for your project.
Status: Required
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
Status: Optional
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short.
If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. This is a suggested structure, each one can do according to the needs of the project. We will now cover each of the structure's topics and other additional points.
Markdown is a text to HTML conversion tool. You write using simple, easy-to-read and easy-to-write text and then it is transformed into valid HTML.
Markdown was created by John Gruber and Aaron Swartz and their source code was written in Perl. This is the official website here
You can view MarkDown within VS Code by adding an extension:
You can view MarkDown within VS Code by adding an extension:
| Shortcuts | Functionality |
|---|---|
| cmd-k v or ctrl-k | Open preview to the Side |
| cmd-shift-v or ctrl-shift-v | Open preview |
Status: Optional
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Status: Required
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos).
The safest way to keep the files is to create a folder of screenshots, github, assets, resources or whatever name you want and leave the files in it. If you use an image or gif CDN it may work but you risk breaking the link someday.
Status: Required
| Day | Description | Technologies |
|---|---|---|
| 03/08 | Accelerating your evolution |   |
| 05/08 | The choice of stack |   |
| 07/08 | The extra mile |
- Creating a landing page structure
- Stylizing landing page
- Authentication
- Login / Logout
- Stay logged in - Token
Status: Required
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
| Technology | Version | Command to install |
|---|---|---|
| NodeJS | 12.18.2 | brew install node |
| Yarn | 1.17.3 | npm install -g yarn |
| Expo | 3.23.1 | yarn add global expo-cli |
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Strikethrough Strikethrough (when enable html tag decode.)
Italic Italic
Emphasis Emphasis
Emphasis Italic Emphasis Italic
Superscript: X2，Subscript: O2
$ npm install marked
Indented 4 spaces, like <pre> (Preformatted Text).
<?php
echo "Hello world!";
?>
Code Blocks (Preformatted text):
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
<!DOCTYPE html>
<html>
<head>
<mate charest="utf-8" />
<title>Hello world!</title>
</head>
<body>
<h1>Hello world!</h1>
</body>
</html>© & ¨ ™ ¡ £ & < > ¥ € ® ± ¶ § ¦ ¯ « ·
X² Y³ ¾ ¼ × ÷ »
18ºC " '
*literal asterisks*
First, clone the repository for your environment:
> git clone https://github.com/shyoutarou/REPO_NAME.git Then, enter the cloned repository and the directory corresponding to the one you want to test (web, server). Soon after, enter the following commands in your terminal for each directory respectively:
# Enter directory "REPO_NAME"
> cd ./REPO_NAME
# Installs all dependencies
> yarn install or npm install
Status: Optional
Indicates whether the project is under development or has already been completed. If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Status: Optional
Offer people a form of contact. It can be any combination of contacts, a chat room, an email address, etc.
Feel free to register a new problem with its title and description in the Proffy repository.
If you have already found a solution to your problem, I would love to review your pull request!
Status: Required
If you have ideas for releases in the future, it is a good idea to list them in the README. State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Follow the steps below to contribute:
-
Fork the project (https://github.com/shyoutarou/REPO_NAME.git)
-
Clone your fork to your machine (
git clone https://github.com/user_name/REPO_NAME.git) -
Create a branch to perform your modification (
git checkout -b feature/name_new_feature) -
Add your modifications and commit (
git commit -m "Describe your modification") -
Push (
git push origin feature/name_new_feature) -
Create a new Pull Request
-
Okay, now just wait for the analysis
Status: Optional
Show your appreciation to those who have contributed to the project.
| Eu |
|---|
|
Status: Required
-
Banner
-
MarkDown
-
Badges
-
GIFS
-
Guias
Status: Required
If your project is open source, it's important to include a license.
The project published in 2020 on the license MIT ❤️
Made with ❤️ by Shyoutarou
Liked? Leave a little star to help the project ⭐