pdxcodemonkey commented on a change in pull request #755: URL: https://github.com/apache/geode-native/pull/755#discussion_r585695640
########## File path: README.md ########## @@ -1,27 +1,53 @@ -[<img src="https://geode.apache.org/img/Apache_Geode_logo.png"; align="center"/>](http://geode.apache.org) +[](http://geode.apache.org) -[](https://travis-ci.org/apache/geode-native) [](https://www.apache.org/licenses/LICENSE-2.0) [](https://lgtm.com/projects/g/apache/geode-native/alerts/) [](https://lgtm.com/projects/g/apache/geode-native/context:cpp) [](https://lgtm.com/projects/g/apache/geode-native/context:csharp) [](https://lgtm.com/projects/g/apache/geode-native/context:javascript) +[](https://concourse.apachegeode-ci.info/teams/main/pipelines/geode-native-develop) +[](https://www.apache.org/licenses/LICENSE-2.0) +[](https://lgtm.com/projects/g/apache/geode-native/alerts/) +[](https://lgtm.com/projects/g/apache/geode-native/context:cpp) +[](https://lgtm.com/projects/g/apache/geode-native/context:csharp) +[](https://lgtm.com/projects/g/apache/geode-native/context:javascript) -**[Overview](#overview)** -**[Building from Source](#building)** -**[Application Development](#development)** +Table of Contents +================= +* [Overview](#overview) +* [Building from Source](#building-from-source) +* [Application Development](#application-development) +* [Versioning](#versioning) +* [Export Control](#export-control) -## <a name="overview"></a>Overview +# Overview -Native Client is a client implementation for [Apache Geode](http://geode.apache.org/) that does not require the Java server JARs. +Native Client is a client implementation for [Apache Geode](http://geode.apache.org/) that does not require the Java +server JARs. -## <a name="building"></a>Building from Source +# Building from Source Directions to build Native Client from source can be found in the source distribution in [BUILDING.md](BUILDING.md). -## <a name="development"></a>Application Development +# Application Development Native Client applications can be written in these client technologies: -* [C++] (https://isocpp.org) -* [C#] (https://msdn.microsoft.com/en-us/library/ms228593.aspx) +* [C++](https://isocpp.org) +* [.NET Framework](https://dotnet.microsoft.com/learn/dotnet/what-is-dotnet-framework) -## Export Control +# Versioning + +Geode Native follows the [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) specification (semver). This +specification only addresses the [API](https://en.wikipedia.org/wiki/API) compatibility with libraries and does not +cover [ABI](https://en.wikipedia.org/wiki/Application_binary_interface) compatibility. + +## C++ + +ABI compatibility is not preserved similarly to the API compatibility. ABI compatibility is only guaranteed between +patch releases. Recompilation is required for both minor and major releases. + +## .NET + +ABI compatibility is preserved similarly to the API compatibility. ABI compatibility is guaranteed between path and Review comment: Typo here, I think - should be `patch`, not `path`. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
![https://geode.apache.org/img/Apache_Geode_logo.png"](https://geode.apache.org/img/Apache_Geode_logo.png"){kind=link}
