Commit 4bd8ac51 authored by Greg Williams's avatar Greg Williams
Browse files

Fixed/added some links in README.md and DEVELOP.md.

parent 6a9ae200
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -26,7 +26,7 @@ API Documentation

There are also some additional [architectural notes](docs) and time-sequence diagrams.

[docs]: https://github.com/Seagate/kinetic-c/blob/master/docs/sequence_diagrams/arch_docs.md
[Architectural Document](docs/sequence_diagrams/arch_docs.md)

Common Developer Tasks
----------------------
+3 −1
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ Getting Started

    > make start_sims # starts bundled kinetic-java simulators for testing
    > make all # this is what Travis-CI build does does for regression testing
    > make stop_sims # stops all locally running simulators

API Documentation
=================
@@ -85,13 +86,14 @@ API Documentation

**NOTE: Configuration structures `KineticClientConfig` and `KineticSessionConfig` should be initialized per C99 struct initialization or memset to 0 prior to use in order to ensure forward/backward compatibility upon changes to these structure definitions!**

[Developer Documentation](DEVELOP.md)

Client Test Utility
===========================

Code examples are included for reference as part of a test utility. The source code for the utility is used to build both a static and dynamically linked verion of the kinetic-c-client library.

* `kinetic-c-util` builds/links against Kinetic C static library (.a)
* `kinetic-c-util.x.y.z` builds/links against Kinetic C dynamic library (.so)

Usage
----------
+2 −2
Original line number Diff line number Diff line
@@ -24,12 +24,12 @@ A message going through the message bus, with no errors.

A message going through the message bus, with no reply (a time-out error).

![](msg_handling-no_reply.wsd?raw=true)
![](msg_handling-no_reply.png?raw=true)


A message going through the message bus, with a hang-up error while sending.

![](msg_handling-send_error.wsd?raw=true)
![](msg_handling-send_error.png?raw=true)


# Entities