Skip to content

Commit

Permalink
minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
clovett committed Feb 21, 2017
1 parent de47f3b commit cb212bc
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/code_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ This is the library developed by our own team member [Chris Lovett](https://gith
See [MavLinkCom](../MavLinkCom/README.md) for more info.

## Sample Programs
We have created a few sample programs to demonstrate how to use the API. See HelloDrone and DroneServer. DroneServer demonstrates how to connect to the simulator using UDP port for QGC.
We have created a few sample programs to demonstrate how to use the API. See HelloDrone and DroneShell.
DroneShell demonstrates how to connect to the simulator using UDP. The simulator is running a server (similar to DroneServer).

## Contributing

Expand Down
6 changes: 3 additions & 3 deletions docs/coding_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ When overriding virtual method, use override suffix.

This is really about memory management. A simulator has much performance cricial 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 C++ 11
[C++ 11 smart pointers](https://cppstyle.wordpress.com/c11-smart-pointers/).
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
[C++ 11 smart pointers](https://cppstyle.wordpress.com/c11-smart-pointers/).
But smart pointers do have a cost, so don’t use them blindly everywhere. For private code
where performance is paramount, raw pointers can be used. Raw pointers are also often needed when interfacing with legacy systems
that only accept pointer types, for example, sockets API. But we try to wrap those legacy interfaces as
Expand Down
18 changes: 17 additions & 1 deletion docs/install_boost.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,20 @@
3. Open a VS2015 x64 Native Command Prompt, `cd %BOOST_ROOT%`, and run `bootstrap.bat`.
4. From that same location run
`b2 variant=debug,release link=static runtime-link=shared threading=multi address-model=64`
and wait about 20 minutes (coffee time :-). Note: On Linux, you can drop the `address-model=64`.
and wait about 20 minutes (coffee time :-). Note: On Linux, you can drop the `address-model=64` and just build release `variant=release`.


## Linux

On Linux if you need a command line way to do this try the following:

````
wget https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.zip/download
unzip download
rm boost_1_63_0.zip
echo export BOOST_ROOT=$PWD/boost_1_63_0 >> ~/.bashrc
source ~/.bashrc
cd boost_1_63_0
./bootstrap.sh
./b2 variant=release link=static runtime-link=shared threading=multi
````

0 comments on commit cb212bc

Please sign in to comment.