Lely core libraries  2.2.5
README.md
1 # Lely core libraries
2 
3 The Lely core libraries are a collection of C and C++ libraries and tools,
4 providing hih-performance I/O and sensor/actuator control for robotics and IoT
5 applications. The libraries are cross-platform and have few dependencies. They
6 can be even be used on bare-metal microcontrollers with as little as 32 kB RAM.
7 
8 ## Overview
9 
10 The Lely core libraries consist of:
11 - C11 and POSIX compatibility library (liblely-libc)
12 - Test Anything Protocol (TAP) library (liblely-tap)
13 - Utilities library (liblely-util)
14 - Event library (liblely-ev)
15 - Asynchronous I/O library (liblely-io2)
16 - CANopen library (liblely-co)
17 - C++ CANopen application library (liblely-coapp)
18 
19 Click [here](https://opensource.lely.com/canopen/docs/overview/) for more
20 details.
21 
22 ## Getting started
23 
24 ### Download
25 
26 Pre-built Debian packages are available on our
27 [Ubuntu PPA](https://launchpad.net/~lely/+archive/ubuntu/ppa).
28 
29 You can download the source code from the
30 [Releases](https://gitlab.com/lely_industries/lely-core/-/releases) page, or
31 clone this repository with
32 
33  $ git clone https://gitlab.com/lely_industries/lely-core.git
34 
35 ### Build and install
36 
37 This project uses the GNU Build System (`configure`, `make`, `make install`),
38 available on Linux and Windows (through [Cygwin](https://www.cygwin.com/)). To
39 build the libraries and tools, you need to install the autotools (autoconf,
40 automake and libtool). After the initial clone or download of the source,
41 generate the `configure` script by running
42 
43  $ autoreconf -i
44 
45 in root directory of the project. This step only has to be repeated if
46 `configure.ac` or one the the `Makefile.am` files changes.
47 
48 First, configure the build system by running
49 
50  $ ./configure --disable-python
51 
52 If you do not want to clutter the source directories with object files, you can
53 run `configure` from another directory. `--disable-python` disables the
54 deprecated Python bindings. The `configure` script supports many other options.
55 The full list can be shown with
56 
57  $ ./configure --help
58 
59 and is documented
60 [here](https://opensource.lely.com/canopen/docs/configuration/).
61 
62 Once the build system is configured, the libraries and tools can be built with
63 
64  $ make
65 
66 The optional test suite can be run with
67 
68  $ make check
69 
70 If you have [doxygen](http://www.doxygen.org/) and
71 [Graphviz](http://www.graphviz.org/) installed, you can build the HTML
72 documentation of the API with
73 
74  $ make html
75 
76 Finally, install the binaries, headers and documentation by running
77 
78  # make install
79 
80 as root.
81 
82 Click [here](https://opensource.lely.com/canopen/docs/installation/) for more
83 information about building the Lely-core libraries from source, as well as
84 instructions for cross-compilation.
85 
86 ## Documentation
87 
88 The doxygen-generated API documentation of the latest development version can be
89 found [here](http://lely_industries.gitlab.io/lely-core/doxygen/).
90 
91 ## Licensing
92 
93 Copyright 2013-2020 [Lely Industries N.V.](http://www.lely.com)
94 
95 Licensed under the Apache License, Version 2.0 (the "License");
96 you may not use this file except in compliance with the License.
97 You may obtain a copy of the License at
98 
99  http://www.apache.org/licenses/LICENSE-2.0
100 
101 Unless required by applicable law or agreed to in writing, software
102 distributed under the License is distributed on an "AS IS" BASIS,
103 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
104 See the License for the specific language governing permissions and
105 limitations under the License.