RTK/Users: Difference between revisions

From Openrtk
Jump to navigation Jump to search
(Created page with "=== User's guide === TODO")
 
No edit summary
Line 1: Line 1:
=== User's guide ===
= User's guide =


TODO
== What is RTK? ==
RTK is an open source C++ library, not an executable. This means that you must write code that uses RTK and compile it before you will obtain something that you can run and get a result from. It also means that you can adapt or extend RTK to address your problem at hand. To facilitate this over multiple operating systems, compilers, and system configurations, RTK itself must be built from its source code. The three steps to starting to work with RTK are therefore:
 
#Download/Obtain/Get the RTK source
#Build the RTK library
#Write your own code that uses RTK and build it, linking to the RTK library.
 
In the next sections we describe each of this steps.
 
== Requirements ==
In order to compile RTK you will need the following:
* GIT (in order to get the software)
* CMake (in order to configure RTK)
* C/C++ compiler
 
== Getting RTK ==

Revision as of 06:21, 27 August 2012

User's guide

What is RTK?

RTK is an open source C++ library, not an executable. This means that you must write code that uses RTK and compile it before you will obtain something that you can run and get a result from. It also means that you can adapt or extend RTK to address your problem at hand. To facilitate this over multiple operating systems, compilers, and system configurations, RTK itself must be built from its source code. The three steps to starting to work with RTK are therefore:

  1. Download/Obtain/Get the RTK source
  2. Build the RTK library
  3. Write your own code that uses RTK and build it, linking to the RTK library.

In the next sections we describe each of this steps.

Requirements

In order to compile RTK you will need the following:

  • GIT (in order to get the software)
  • CMake (in order to configure RTK)
  • C/C++ compiler

Getting RTK