celix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pnol...@apache.org
Subject svn commit: r1770643 - /celix/site/trunk/content/documentation.mdtext
Date Mon, 21 Nov 2016 11:05:06 GMT
Author: pnoltes
Date: Mon Nov 21 11:05:05 2016
New Revision: 1770643

URL: http://svn.apache.org/viewvc?rev=1770643&view=rev
Log:
CELIX-384: Updates the documentation page

Modified:
    celix/site/trunk/content/documentation.mdtext

Modified: celix/site/trunk/content/documentation.mdtext
URL: http://svn.apache.org/viewvc/celix/site/trunk/content/documentation.mdtext?rev=1770643&r1=1770642&r2=1770643&view=diff
==============================================================================
--- celix/site/trunk/content/documentation.mdtext (original)
+++ celix/site/trunk/content/documentation.mdtext Mon Nov 21 11:05:05 2016
@@ -1,10 +1,27 @@
 Title: Documentation
 
-Most of the documentation for Apache Celix resides in git. 
+The technical documentation for Apache Celix resides in git.
+
+
+##Introduction
+An introduction to Apache Celix can found at [Apache Celix - Introduction](https://github.com/apache/celix/blob/master/documents/intro/readme.md).
+This page documents how OSGi is adapted for C/C++, how the Java API is mapped to C and also
gives an short introduction to services and bundles. 
+
+
+##Building and Installing
+How to build and install Apache Celix is documented at [Building and Installing](https://github.com/apache/celix/blob/master/documents/building/readme.md)
+
+
+##Getting Started
+A more in depth look at bundles and services (for C and C++) is given in [Getting Started
Guide](https://github.com/apache/celix/blob/master/documents/getting_started/readme.md).
+
+
+##Subproject
+OSGi is framework for modular software development and as result a lot of functionality Apache
Celix offers in developed in OSGi bundles configured as CMake sub-projects.
+An overview of the available sub-projects and some info can be found at [Subprojects](https://github.com/apache/celix/blob/master/documents/subprojects/readme.md).
+
+##CMake Commands
+Apache Celix uses CMake as build tool. To support the notion of bundles and OSGi deployments
(a selection of bundles combined with some configuration) some custom CMake commands are used.
+These custom commands are documented at [CMake Commands](https://github.com/apache/celix/blob/master/documents/cmake_commands/readme.md).
+
 
-Links:
- - [Apache Celix - Introduction](https://github.com/apache/celix/blob/master/documents/intro/readme.md)
- - [Apache Celix - Building and Installing](https://github.com/apache/celix/blob/master/documents/building/readme.md)
- - [Apache Celix - Getting Started Guide](https://github.com/apache/celix/blob/master/documents/getting_started/readme.md)
- - [Apache Celix - Subprojects](https://github.com/apache/celix/blob/master/documents/subprojects/readme.md)
- - [Apache Celix - CMake Commands](https://github.com/apache/celix/blob/master/documents/cmake_commands/readme.md)



Mime
View raw message