Skip to content

Commit

Permalink
Update faq.
Browse files Browse the repository at this point in the history
  • Loading branch information
wanglei828 authored and startcode committed Sep 13, 2017
1 parent fd4cac0 commit 77b6045
Showing 1 changed file with 38 additions and 28 deletions.
66 changes: 38 additions & 28 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,47 @@
# FAQ
## I am new to this project, where should I start?
### --- If you do not have a vehicle
If you want to build apollo on your computer, please start with [README.md](https://github.com/ApolloAuto/apollo/blob/master/README.md)
## I am new to the Apollo project, where do I start?
You have several options:
- To build apollo on your computer, start by reviewing the [README.md](https://github.com/ApolloAuto/apollo/blob/master/README.md)

If you don't want to build apollo and only want to run it for offline demo, please refer [apollo/docs/demo_guide/README.md](https://github.com/ApolloAuto/apollo/blob/master/docs/demo_guide/README.md).
### --- If you have a vehicle
If you are a user and would like to install and build Apollo, please refer [apollo/docs/quickstart/apollo_1_0_quick_start.md](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start.md).

If you are a developer and would like to build the Apollo Kernel, the Robot Operating System (ROS), and Apollo, please refer [apollo/docs/quickstart/apollo_1_0_quick_start_developer.md](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start_developer.md).
- To run the Apollo demo offline, go to: [apollo/docs/demo_guide/README.md](https://github.com/ApolloAuto/apollo/blob/master/docs/demo_guide/README.md).
- To install and build Apollo on a vehicle, go to: [apollo/docs/quickstart/apollo_1_0_quick_start.md](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start.md).
- To build the Apollo Kernel, the Robot Operating System (ROS), and Apollo, go to: [apollo/docs/quickstart/apollo_1_0_quick_start_developer.md](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start_developer.md).

## How to debug build problems?
1. Please make sure you followed the guidance in the correct help document as listed in the first question.

2. Please make sure you followed exactly the same steps in the document.

3. Currently, build can only be done on Linux, we recommend Ubuntu 14.04.

4. Please double check the internet setting on your computer is correct.
1. Carefully review the instructions in the documentation for the option that you selected to get started with the Apollo project.
2. Make sure that you follow the steps in the document exactly as they are written.
3. Use Ubuntu 14.04 as the build can only be implemented using Linux.
4. Verify that the Internet setting is correct on your computer.
5. Allocate more than 1GB of memory, at the recommended minimum, for your computer.

5. Please allocate sufficient memory for your computer. It is recommended to have > 1GB memory.

## I cannot solve my build problems, what is the most effective way to ask for help?
So far, many build problems are related to environment setting. You can run the script to get your environment: `bash scripts/env.sh >& env.txt` and provide the content of env.txt in your post.
## If I cannot solve my build problems, what is the most effective way to ask for help?
Many build problems are related to the environment settings.
1. Run the script to get your environment: `bash scripts/env.sh >& env.txt`
2. Provide the content of env.txt in your post.

## Which ports need be white list to run Apollo in public cloud instance?
8887: HMI
8888: Dreamview
Use these ports for HMI and Dreamview:
- 8887: HMI
- 8888: Dreamview

## Why there is no ROS environment in dev docker?
The ROS package will be downloaded when you start to build apollo with command `bash apollo.sh build`. Please run command `source /apollo/scripts/apollo_base.sh` inside docker to set up the ROS environment after build is complete, and then you can run ROS related comands, such as rosbag, rostopic and so on.

## How to clean the existing build output?
Log into the docker with command `bash docker/scripts/dev_into.sh`, and run command `bash apollo.sh clean`.

## How to delete downloaded third party dependent packages?
Log into the docker with command `bash docker/scripts/dev_into.sh`, and run command `bazel clean --expunge`. After this command, the build command `bash apollo.sh build` will redownload all the dependent packages according to the *WORKSPACE* file.
The ROS package is downloaded when you start to build apollo:
`bash apollo.sh build`.
1. Run the following command inside Docker to set up the ROS environment after the build is complete:
`source /apollo/scripts/apollo_base.sh`
2. Run ROS-related commands such as rosbag, rostopic and so on.

## How do I clean the existing build output?
Follow these steps:
1. Log into Docker using the command:
`bash docker/scripts/dev_into.sh`
2. Run the command:
`bash apollo.sh clean`

## How do I delete the downloaded third party dependent packages?
Follow these steps:
1. Log into Docker using the command:
`bash docker/scripts/dev_into.sh`
2. Run the command:
`bazel clean --expunge`
The build command, `bash apollo.sh build`, then downloads all of the dependent packages according to the *WORKSPACE* file.

0 comments on commit 77b6045

Please sign in to comment.