From f502b6f79163deda4a1c4a97484b77544aa374ad Mon Sep 17 00:00:00 2001 From: Judith Date: Thu, 26 Aug 2021 09:32:36 +0000 Subject: [PATCH] add translation-projects/ How-to-Write-About. Add the instructions on how to write the About section of a project. --- translation-projects/ How-to-Write-About | 36 ++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 translation-projects/ How-to-Write-About diff --git a/translation-projects/ How-to-Write-About b/translation-projects/ How-to-Write-About new file mode 100644 index 0000000..bb0f851 --- /dev/null +++ b/translation-projects/ How-to-Write-About @@ -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