README.md 3.9 KB
Newer Older
Z
Zhang Xingtao 已提交
1 2 3
# Howto Guides

## Build
4
- [How to launch and run Apollo](how_to_launch_and_run_apollo.md)
5 6
- [How to build your own kernel](how_to_build_your_own_kernel.md)
- [How to install apollo kernel](how_to_install_apollo_kernel.md)
7
- [How to save and load docker image](how_to_save_and_load_docker_image.md)
N
Natasha Dsouza 已提交
8 9 10

#### Chinese versions
- [How to install apollo kernel](how_to_install_apollo_kernel_cn.md)
11 12 13

## Contribution
- [How to document code](how_to_document_code.md)
14
- [How to create a pull request](how_to_create_pull_request.md)
Z
Zhang Xingtao 已提交
15 16

## Debugging and troubleshooting
17 18
- [How to troubleshoot your ESD CAN device](how_to_troubleshoot_esdcan.md)

N
Natasha Dsouza 已提交
19 20 21
### Chinese versions
- [How to troubleshoot your ESD CAN device](how_to_troubleshoot_esdcan_cn.md)

22 23 24 25 26 27 28 29 30 31
## Extended modules
- [How to add a gps receiver](how_to_add_a_gps_receiver.md)
- [How to add a new CAN card](how_to_add_a_new_can_card.md)
- [How to add a new control algorithm](how_to_add_a_new_control_algorithm.md)
- [How to add a new evaluator in prediction module](how_to_add_a_new_evaluator_in_prediction_module.md)
- [How to add a new predictor in prediction module](how_to_add_a_new_predictor_in_prediction_module.md)
- [How to add a new vehicle](how_to_add_a_new_vehicle.md)
- [How to add an external dependency](how_to_add_an_external_dependency.md)
- [How to Run MSF Localization Module On Your Local Computer](how_to_run_MSF_localization_module_on_your_local_computer.md)
- [How to train Prediction's MLP model](how_to_train_prediction_mlp_model.md)
N
Natasha Dsouza 已提交
32
- [How to use the navigation mode of Apollo 2.5](how_to_use_apollo_2.5_navigation_mode.md)
33
- [How to setup Dual IPCs for Apollo 3.5](how_to_setup_dual_ipc.md)
N
Natasha Dsouza 已提交
34 35 36 37 38 39 40 41 42 43 44

### Chinese versions

- [How to add a gps receiver](how_to_add_a_gps_receiver_cn.md)
- [How to add a new CAN card](how_to_add_a_new_can_card_cn.md)
- [How to add a new control algorithm](how_to_add_a_new_control_algorithm_cn.md)
- [How to add a new evaluator in prediction module](how_to_add_a_new_evaluator_in_prediction_module_cn.md)
- [How to add a new predictor in prediction module](how_to_add_a_new_predictor_in_prediction_module_cn.md)
- [How to add a new vehicle](how_to_add_a_new_vehicle_cn.md)
- [How to Run MSF Localization Module On Your Local Computer](how_to_run_MSF_localization_module_on_your_local_computer_cn.md)
- [How to train Prediction's MLP model](how_to_train_prediction_mlp_model_cn.md)
N
Natasha Dsouza 已提交
45
- [How to use the navigation mode of Apollo 2.5 cn](how_to_use_apollo_2.5_navigation_mode_cn.md)
46 47 48 49 50

## Architecture
- [How to understand Apollo's core architecture and workflow](how_to_understand_architecture_and_workflow.md)

## Helper tools and optimization
N
Natasha Dsouza 已提交
51
- [How to Leverage Apollo's RTK mode](how_to_leverage_rtk_mode.md)
N
Natasha Dsouza 已提交
52
- [How to run the Map Data Verification Tool](how_to_run_map_verification_tool.md)
53 54 55
- [How to run perception module on your local computer](how_to_run_perception_module_on_your_local_computer.md)
- [How to tune control parameters](how_to_tune_control_parameters.md)
- [How to update vehicle calibration](how_to_update_vehicle_calibration.md)
N
Natasha Dsouza 已提交
56
- [How to do performance profiling](how_to_do_performance_profiling.md)
N
Natasha Dsouza 已提交
57
- [How to Run RTK Localization Module On Your Local Computer](how_to_run_RTK_localization_module_on_your_local_computer.md)
N
Natasha Dsouza 已提交
58 59 60 61

### Chinese versions
- [How to tune control parameters](how_to_tune_control_parameters_cn.md)
- [How to update vehicle calibration](how_to_update_vehicle_calibration_cn.md)
N
Natasha Dsouza 已提交
62
- [How to Run RTK Localization Module On Your Local Computer](how_to_run_RTK_localization_module_on_your_local_computer_cn.md)
Z
Zhang Xingtao 已提交
63 64

## Others
N
Natasha Dsouza 已提交
65
- [How to generate and push images into Docker](how_to_generate_and_push_docker_images.md)
66
- [How to clone Apollo repository from China](how_to_clone_apollo_repo_from_china.md)
N
Natasha Dsouza 已提交
67 68 69

### Chinese versions
- [How to generate and push images into Docker](how_to_generate_and_push_docker_images_cn.md)
70
- [国内环境下如何克隆Apollo 仓库](how_to_clone_apollo_repo_from_china_cn.md)
71
- [How to solve slow pull from CN](how_to_solve_slow_pull_from_cn.md)