mmdeploy/docs/en/01-how-to-build/build_from_source.md
lvhan028 e929201827
[Docs] reorganize the documents in English and update the contents based on v0.5.0 status (#531)
* checkout qq group qrcode

* update the cover image

* update build doc

* reorganize chapters

* update readme

* remove index of build on different platforms in readthedocs

* update benchmark

* update get started document in Chinese based on the prebuild package

* update get_started

* re-style benchmark

* update get_started in zh_cn

* update get_started in english

* update get_started in english

* update get_started in english

* update get_started doc

* update according to reviewer comments

* update linker ci

* fix(.github/scripts/check_doc_linker.py): skip code block

* specify PYTHONPATH

* update get_started

* update diagram

* rename some documents

* fix according to reviewer comments

Co-authored-by: tpoisonooo <khj.application@aliyun.com>
2022-06-07 18:05:51 +08:00

39 lines
990 B
Markdown

# Build From Source
## Download
```shell
git clone -b master git@github.com:open-mmlab/mmdeploy.git --recursive
```
Note:
- If fetching submodule fails, you could get submodule manually by following instructions:
```shell
cd mmdeploy
git clone git@github.com:NVIDIA/cub.git third_party/cub
cd third_party/cub
git checkout c3cceac115
# go back to third_party directory and git clone pybind11
cd ..
git clone git@github.com:pybind/pybind11.git pybind11
cd pybind11
git checkout 70a58c5
```
- If it fails when `git clone` via `SSH`, you can try the `HTTPS` protocol like this:
```shell
git clone -b master https://github.com/open-mmlab/mmdeploy.git --recursive
```
## Build
Please visit the following links to find out how to build MMDeploy according to the target platform.
- [Linux-x86_64](linux-x86_64.md)
- [Windows](windows.md)
- [Android-aarch64](android.md)
- [NVIDIA Jetson](jetsons.md)