Banner 1
Banner 2
hero

Phạm Văn Tú

4518 thành viên

  1. Trang chủ /
  2. Git /
  3. README là gì và viết README như nào?

README là gì và viết README như nào?

10/25/2022
Git

Trong bài viết này mình cùng tìm hiểu về file readme là gì nhé.

Nó là 1 file dùng để giới thiếu dự án, cấu trúc cũng tài liệu cho dự án. Tạo file README.md (tên này là tiêu chuẩn để cho github, gitlab.. nhận diện được đó là file mô tả cho dự chúng ta) do sử dụng cú pháp Markdown để viết nên file có đuôi là .md á nghen ae

Ae có thể lên trang markdownguide hoặc document trên github của nó để xem cho đầy đủ cụ thể nhé. Mình có ví dụ những trường hợp thường dùng để viết mardown như các thẻ tiêu đề, thẻ văn bản, in đậm, in nghiêng, danh sách, chèn code….ae tạo file copy chạy thử nhé

# Đây là h1
## Đây là h2
### Đây là h3

Đây là một thẻ p bình thường

Đây là danh sách ul, li
- Đây là li 1
- Đây là li 2

[Đây là thẻ a](fb.com)

![Đây là mô tả cho hình ảnh](https://anhdepbonphuong.com/wp-content/uploads/2016/12/hinh-nen-dep-cho-may-tinh-nature-wallpapers-nature-wallpaper-latest-beautiful-wallpapers-800x480.jpg)

**In đậm**

*In nghiêng*

`console.log('Chèn code ngon lành luôn')`

```js
const a = 100;
Hello Readme
git status
hero