## 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)
- To run the Apollo demo offline, go to: [Apollo 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 2.0 quick start](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_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) and refer to [build kernel](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start_developer.md#build-the-apollo-kernel).
## How to debug build problems?
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.
6. If roscore cannot start in apollo docker, you may need to tune the master start timeout value in ROS. You may want to check a related user-reported [issue](https://github.com/ApolloAuto/apollo/issues/2500) for more details.
## 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 must be whitelisted to run Apollo in a public cloud instance?
Use these ports for HMI and Dreamview:
- 8888: Dreamview
## Why there is no ROS environment in dev docker?
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.
## 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)
- To run the Apollo demo offline, go to: [Apollo 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 1.0 quick start](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) and refer to [build kernel](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_0_quick_start_developer.md#build-the-apollo-kernel).
---
## How do I send a pull request?
Sending a pull request is simple.
1. Fork Apollo Repository into your GitHub.
1. Fork the Apollo Repository into your GitHub.
2. Create a Developer Branch in your Repository.
3. Commit your change in your Developer Branch.
4. Send the pull request from your GitHub Repository Webpage.
---
## Do comments need to be made in Doxygen?
Yes, currently all comments need to be made in Doxygen.
---
## How to debug build problems?
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.
6. If roscore cannot start in apollo docker, you may need to tune the master start timeout value in ROS. You may want to check a related user-reported [issue](https://github.com/ApolloAuto/apollo/issues/2500) for more details.
---
## 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. Post the content of env.txt to our Github issues page and someone from our team will get in touch with you.
---
## Which ports must be whitelisted to run Apollo in a public cloud instance?
Use these ports for HMI and Dreamview:
- 8888: Dreamview
---
## Why there is no ROS environment in dev docker?
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.
We have only tested on Ubuntu which means it's the only operating system we currently officially support. Ubuntu is an ideal operating system as ROS is required to support it. Users are always welcome to try different operating systems and can share their patches with the community if they are successfully able to use them.
---
## I’m having difficulty connecting to localhost:8888 (Dreamview).
The Dreamview web server is provided by the dreamview node(A node is an executable in ROS concept). Before accessing the Dreamview page, you need to build the system(including dreamview node) within the docker container following the [guide](https://github.com/ApolloAuto/apollo/blob/master/README.md). Once built, dreamview node will be started after the step `bash scripts/bootstrap.sh`.
...
...
@@ -14,14 +15,17 @@ So if you can not access Dreamview, please check:
* Make sure the address and port are not blocked by the firewall.
* Make sure you're using <apollo_host_ip>:8888 instead of localhost:8888 if you are not accessing the Dreamview page through the host machine.
---
## How can I perform step-by-step debugging?
The majority of bugs can be found through logging (using AERROR, AINFO, ADEBUG). If step-by-step debugging is needed, we recommend using gdb.
---
## How do I run the Offline Perception Visualizer?
Refer to the How-To guide located [here](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_run_offline_perception_visualizer.md).
---
## Ubuntu 14.04 login loop problem after installing the pre-built Apollo kernel.
Here is a solution to solve this problem:
...
...
@@ -30,4 +34,8 @@ Here is a solution to solve this problem:
* Press 'Ctrl+Alt+F1' and install 'NVIDIA-Linux-x86_64-375.39.run' according to the [link](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_0_hardware_system_installation_guide_v1.md).
* Reboot and start computer with the default boot loader with Apollo kernel.
---
## How do I add a new module
Apollo currently functions as a single system, therefore before adding a module to it, understand that there would be a lot of additional work to be done to ensure that the module functions perfectly with the other modules of Apollo. Simply add your module to the `modules/` folder. You can use `modules/routing` as an example, which is a relatively simple module. Write the BUILD files properly and apollo.sh will build your module automatically
