diff --git a/README.md b/README.md index 5bd27b0..7977b7e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -# The documentation of Ascend NPU for PyTorch(torch_npu) +# The Doc of Ascend Supported Open Source project -This repository is a collection of documentation, api and stuff like that for torch_npu (Ascend NPU for PyTorch). +This repository is a collection of documentation for Ascend supported open source projects. + +# Structure + +- `index.rst`: the index of the opensource project doc. +- `quick_start.rst`: **5 minutes** or **600 words**, quickstarts enable people to quickly complete a discrete, focused task by illustrating a workflow with **only essential steps**. See also in [Github quickstart guide](https://docs.github.com/en/contributing/style-guide-and-content-model/quickstart-content-type). +- `install.rst`: installation guide, including common installation (such as binary, pypi, conda) for developers and a quick installation verification +- `tutorial.rst`: more complex than quickstart, help people learn about **products** and solve **real world problems** by guiding them through **the entire workflow to complete a task**. See also in [Github tutorial guide](https://docs.github.com/en/contributing/style-guide-and-content-model/tutorial-content-type). +- `faq.rst`: A frequently asked questions (FAQ) list. # Contributing