Skip to content

Commit

Permalink
docs related pull requests
Browse files Browse the repository at this point in the history
  • Loading branch information
sytelus committed Aug 14, 2017
1 parent 633d211 commit d7e925c
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,41 +11,41 @@ for autonomous vehicles. For this purpose, AirSim also exposes APIs to retrieve

[![AirSim Demo Video](docs/images/demo_video.png)](https://youtu.be/-WfTr1-OBGQ)

# Development Status
## Development Status

This project is under heavy development. The current release is in beta and all APIs are subject to change. The next major features currently in works are standalone mode,
several API enhancements and Python client support. We welcome contributions!

# How to Get It
## Prerequisites
## How to Get It
### Prerequisites
To get the best experience you will need Pixhawk or compatible device and a RC controller. This enables the "hardware-in-loop simulation" for
more realistic experience. [Follow these instructions](docs/prereq.md) on how to get it, set it up and other alternatives.

## Windows
### Windows
There are two ways to get AirSim working on your machine. Click on below links and follow the instructions.

1. [Build it and use it with Unreal](docs/build.md)
2. [Use the precompiled binaries](docs/use_precompiled.md)

## Linux
### Linux
[Build AirSim on Ubuntu 16.04](docs/linux_build.md)


# How to Use It
## How to Use It

## Video Tutorials
### Video Tutorials
- [Walkthrough Demo Video](https://youtu.be/HNWdYrtw3f0)
- [AirSim Setup Video](https://youtu.be/1oY8Qu5maQQ) (shows you all the setup steps)

## Manual flights
### Manual flights
If you have a Pixhawk flight controller (or compatible device) and a remote control you can manually control the drones in the simulator
and fly around.

![record screenshot](docs/images/DroneGIF-03.gif)

[More details](docs/manual_flight.md)

## Gathering training data
### Gathering training data
There are two ways you can generate training data from AirSim for deep learning. The easiest way is to simply press the record button on the lower right corner.
This will start writing pose and images for each frame.

Expand All @@ -60,7 +60,7 @@ For MavLink enabled drones, you can also use our [Log Viewer](docs/log_viewer.md

You can also [playback recorded logs](docs/playback.md) for side-by-side comparison between real drone and the simulator.

## Programmatic control
### Programmatic control
The AirSim exposes easy to use APIs in order to retrieve data from the drones that includes ground truth, sensor data as well as various images. It also exposes
APIs to control the drones in a platform independent way. This allows you to use your code to control different drones platforms, for example, Pixhawk or DJI Matrice,
without making changes as well as without having to learn internal protocols details.
Expand All @@ -70,8 +70,8 @@ This way you can write and test your code in simulator and later execute it on t

[More details](docs/apis.md)

# Participate
## Paper
## Participate
### Paper
You can get additional technical details in [our paper (preprint)](https://arxiv.org/abs/1705.05065). Please cite this as:
```
@inproceedings{airsim2017fsr,
Expand All @@ -84,19 +84,19 @@ You can get additional technical details in [our paper (preprint)](https://arxiv
}
```

## Contribute
### Contribute
We welcome contributions to help advance research frontiers.

- [More on our design](docs/design.md)
- [More on our code structure](docs/code_structure.md)
- [Contribution Guidelines](docs/contributing.md)

## Contact
### Contact
Join the [AirSim group at Facebook](https://www.facebook.com/groups/1225832467530667/) to stay up to date or ask any questions.

## FAQ
### FAQ

If you run into problems, check the [FAQ](docs/faq.md) and feel free to post issues on the [AirSim github](https://github.com/Microsoft/AirSim/issues).

## License
### License
This project is released under MIT License. Please review [License file](LICENSE) for more details.
2 changes: 1 addition & 1 deletion docs/coding_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ When overriding virtual method, use override suffix.

## Pointers

This is really about memory management. A simulator has much performance cricial code, so we try and avoid overloading the memory manager
This is really about memory management. A simulator has much performance critical code, so we try and avoid overloading the memory manager
with lots of calls to new/delete. We also want to avoid too much copying of things on the stack, so we pass things by reference when ever possible.
But when the object really needs to live longer than the call stack you often need to allocate that object on
the heap, and so you have a pointer. Now, if management of the lifetime of that object is going to be tricky we recommend using
Expand Down
2 changes: 1 addition & 1 deletion docs/linux_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ On first start you might not see any projects in UE4 editor. Click on Projects t
2. Start UE4Editor as described in previous section and double click on Blocks project. This will rebuild Unreal binaries as well.

## Using AirSim Your Own Unreal Project
To setup your own Unreal environment [see these instructions](unreal_custenv,md).
To setup your own Unreal environment [see these instructions](unreal_custenv.md).

To update your project with AirSim, simply copy the `AirSim/Unreal/Plugins` folder in to your project. You can use this handy command line:
```
Expand Down
2 changes: 1 addition & 1 deletion docs/settings.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# AirSim Settings

## Where are Settings Stored?
AirSim configuration is specified in `settings.json` file located in `Documents\AirSim` folder on Windows (`~/Documents/AirSim` folder on Linux). The file is in usual [json format](](https://en.wikipedia.org/wiki/JSON).
AirSim configuration is specified in `settings.json` file located in `Documents\AirSim` folder on Windows (`~/Documents/AirSim` folder on Linux). The file is in usual [json format](https://en.wikipedia.org/wiki/JSON).

On first startup AirSim would create `settings.json` file with no settings. To avoid problems, always use ASCII format to save json file.

Expand Down

0 comments on commit d7e925c

Please sign in to comment.