Skip to content

Add url link for FAQ doc. #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yifeijiang merged 1 commit into from
Jul 7, 2017
Merged

Add url link for FAQ doc. #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
# 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
### --- 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)

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.
### --- 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.
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.
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).

## 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.
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.

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.

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.