sven
/
libicsneo
mirror of https://github.com/intrepidcs/libicsneo.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove extraneous lines in README

pull/4/head
Paul Hollinsky 2018-11-20 10:47:23 -05:00
parent 8a4e33c8df
commit 422541fcf3
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,11 +1,9 @@
# libicsneo # libicsneo
--- ### The Intrepid Control Systems Open Cross-Platform Device Communication API
### Intrepid Control Systems Open Cross-Platform Device Communication API
An open source solution for communicating with Intrepid Control Systems devices. An open source solution to integrate Intrepid Control Systems vehicle networking hardware with your application.
## Getting Started ## Getting Started
---
There are two major ways to write a new application using libicsneo. You can use the C++ interface, which will be compiled with your project and statically linked, or you can use the C interface, which can be either statically or dynamically linked. There are two major ways to write a new application using libicsneo. You can use the C++ interface, which will be compiled with your project and statically linked, or you can use the C interface, which can be either statically or dynamically linked.
### Integration with CMake (Static Linking) ### Integration with CMake (Static Linking)
Integrating the library with your current CMake project is extremely easy. Integrating the library with your current CMake project is extremely easy.
@ -26,7 +24,6 @@ It is also possible to use the precompiled binaries with runtime linking. It is
5. Call `icsneo_close();` to unload the library. 5. Call `icsneo_close();` to unload the library.
## Usage ## Usage
---
### Using the C++ API ### Using the C++ API
The C++ API is designed to be modern and easy to use. All library functions and classes are in the namespace `icsneo`. Most applications will start by calling `icsneo::FindAllDevices()`. This will return an `std::vector` of `std::shared_ptr<icsneo::Device>` objects. You will want to keep a copy of the `shared_ptr` to any devices you want to use, as allowing it to go out of scope will automatically close the device and free all memory associated with it. The C++ API is designed to be modern and easy to use. All library functions and classes are in the namespace `icsneo`. Most applications will start by calling `icsneo::FindAllDevices()`. This will return an `std::vector` of `std::shared_ptr<icsneo::Device>` objects. You will want to keep a copy of the `shared_ptr` to any devices you want to use, as allowing it to go out of scope will automatically close the device and free all memory associated with it.
@ -107,7 +104,6 @@ icsneo_closeDevice(myDevice);
``` ```
## Building from Source ## Building from Source
---
### Windows ### Windows
Building will require Microsoft Visual Studio 2017 and CMake to be installed. Building will require Microsoft Visual Studio 2017 and CMake to be installed.
### macOS ### macOS