From fa1ba6744f5ab37d88ef991aef7944e8b9514dbc Mon Sep 17 00:00:00 2001 From: Judith Date: Thu, 26 Aug 2021 09:47:41 +0000 Subject: [PATCH 1/2] Added the instructions on how to write the About section of a project --- documentation/how-to-write-about.md | 36 +++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 documentation/how-to-write-about.md diff --git a/documentation/how-to-write-about.md b/documentation/how-to-write-about.md new file mode 100644 index 0000000..bb0f851 --- /dev/null +++ b/documentation/how-to-write-about.md @@ -0,0 +1,36 @@ +### How to write the "About" description of a project + + +"About" (简介) provides a brief introduction to the project. A good "About" is +clear, short, and to the point. + +It may contain one or more of the following information items: + +- What the project is + +- What it does + +- Its core features + +- The technology it uses + +- Its positioning + +For example, + +- iSulad is a light weight container runtime daemon which is designed for IOT + and Cloud infrastructure. + +- A tool for writing better scripts + +- A Python Interpreter written in Rust + +- Powerful, fast, and an easy to use search engine + +- A bundle which aims to provide a full integration of MeilliSearch in Symfony + +"About" can be a short, full sentence or a noun phrase. Choose the right style +based on the project characteristics. + +When we choose to use a noun phrase, start it with an article when needed but do +not use a period (.) at the end. \ No newline at end of file -- Gitee From 03e2c75507ccae161884ba484259867ad29e09ee Mon Sep 17 00:00:00 2001 From: Judith Date: Thu, 26 Aug 2021 09:49:19 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=96=87=E4=BB=B6=20tran?= =?UTF-8?q?slation-projects/=20How-to-Write-About?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- translation-projects/ How-to-Write-About | 36 ------------------------ 1 file changed, 36 deletions(-) delete mode 100644 translation-projects/ How-to-Write-About diff --git a/translation-projects/ How-to-Write-About b/translation-projects/ How-to-Write-About deleted file mode 100644 index bb0f851..0000000 --- a/translation-projects/ How-to-Write-About +++ /dev/null @@ -1,36 +0,0 @@ -### How to write the "About" description of a project - - -"About" (简介) provides a brief introduction to the project. A good "About" is -clear, short, and to the point. - -It may contain one or more of the following information items: - -- What the project is - -- What it does - -- Its core features - -- The technology it uses - -- Its positioning - -For example, - -- iSulad is a light weight container runtime daemon which is designed for IOT - and Cloud infrastructure. - -- A tool for writing better scripts - -- A Python Interpreter written in Rust - -- Powerful, fast, and an easy to use search engine - -- A bundle which aims to provide a full integration of MeilliSearch in Symfony - -"About" can be a short, full sentence or a noun phrase. Choose the right style -based on the project characteristics. - -When we choose to use a noun phrase, start it with an article when needed but do -not use a period (.) at the end. \ No newline at end of file -- Gitee