Change project version, add CHANGELOG and README

CHANGELOG.md

@@ -0,0 +1,17 @@
+# CHANGELOG
+
+Release Versions:
+
+- [0.1.0](#010)
+
+## 0.1.0
+
+A set of drivers, protocols and libraries for communicating between software and hardware devices.
+
+### Features
+
+**ZMQ Interface**
+
+A network interface with ZMQ subscribers and publishers, implemented as a library in both C++ and Python. The library
+defines the message structures using `state_representation` types and the encoding / decoding of the messages
+using `clproto`.

README.md

@@ -1,2 +1,44 @@
 # network-interfaces
+
 A repository of drivers, protocols and libraries for communicating between software and hardware devices.
+
+## Usage
+
+Use the C++ projects in one of the two following ways:
+
+- Include the `include` directory of the network interface library in another `CMakeLists.txt` with
+  ```cmake
+  include_directories(path/to/network-interfaces/cpp/include)
+  ```
+- Install the network interface library to `/usr/local/include` with
+  ```console
+  cd path/to/network-interfaces/cpp && mkdir build && cd build && cmake .. && make install
+  ```
+  and use it in another `CMakeLists.txt` with
+  ```cmake
+  find_library(network_interfaces REQUIRED)
+  ```
+
+For Python, install the library simply with
+
+```console
+cd path/to/network-interfaces/python && pip3 install ./
+```
+
+## Development
+
+To build and run a Docker container as an SSH toolchain server for remote development with
+
+```console
+bash build.sh
+aica-docker server aica-technology/network-interfaces -u ros2 -p 8010
+```
+
+Note: This requires the installation of the `aica-docker` scripts
+from [here](https://github.com/aica-technology/docker-images).
+
+Additionally, to run the tests without an SSH toolchain server, build the image with the `--test` option:
+
+```console
+bash build.sh --test
+```

cpp/CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.9)
-project(network_interfaces VERSION 0.0)
+project(network_interfaces VERSION 0.1.0)
 
 option(BUILD_TESTING "Build tests." OFF)
 

python/setup.py

@@ -2,9 +2,9 @@
 
 setuptools.setup(
     name="network_interfaces",
-    version="0.0",
+    version="0.1.0",
     description="This package implements network interfaces of AICA",
-    # url="https://github.com/pypa/sampleproject",
+    url="https://github.com/aica-technology/network-interfaces",
     packages=setuptools.find_packages(),
     install_requires=[
         "control-libraries>=4.0.0",