celix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pnol...@apache.org
Subject svn commit: r1654888 - in /celix/site/trunk/content: ./ documentation/
Date Mon, 26 Jan 2015 20:27:23 GMT
Author: pnoltes
Date: Mon Jan 26 20:27:22 2015
New Revision: 1654888

URL: http://svn.apache.org/r1654888
Log:
CELIX-144: Added eclipse part to the getting started guid and added is to the menu page

Added:
    celix/site/trunk/content/documentation/getting_started.mdtext
      - copied, changed from r1625367, celix/site/trunk/content/documentation/getting_started.md
    celix/site/trunk/content/documentation/getting_started_img1.png   (with props)
    celix/site/trunk/content/documentation/getting_started_img2.png   (with props)
    celix/site/trunk/content/documentation/getting_started_img3.png   (with props)
Removed:
    celix/site/trunk/content/documentation/getting_started.md
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=1654888&r1=1654887&r2=1654888&view=diff
==============================================================================
--- celix/site/trunk/content/documentation.mdtext (original)
+++ celix/site/trunk/content/documentation.mdtext Mon Jan 26 20:27:22 2015
@@ -2,6 +2,7 @@ Title: Documentation
 
 Currently the documentation for Celix contains information about building and running Celix,
as well as some examples.
 
+- [Getting Started] (/celix/documentation/getting_started.html)
 - [Building and Running Celix](/celix/documentation/buildingandrunning.html)
 - [Design](/celix/documentation/design.html)
 - [Mapping](/celix/documentation/mapping.html)

Copied: celix/site/trunk/content/documentation/getting_started.mdtext (from r1625367, celix/site/trunk/content/documentation/getting_started.md)
URL: http://svn.apache.org/viewvc/celix/site/trunk/content/documentation/getting_started.mdtext?p2=celix/site/trunk/content/documentation/getting_started.mdtext&p1=celix/site/trunk/content/documentation/getting_started.md&r1=1625367&r2=1654888&rev=1654888&view=diff
==============================================================================
--- celix/site/trunk/content/documentation/getting_started.md (original)
+++ celix/site/trunk/content/documentation/getting_started.mdtext Mon Jan 26 20:27:22 2015
@@ -33,7 +33,7 @@ apt-get install -yq --no-install-recomme
 
 
 ##Building & Installing Apache Celix
-To get started you first have to install Apache Celix. To do this you can download a source
release from the [download page](/celix/download.cgi) or checkout the latest version from
svn. For this getting started guide the latest trunk version is assumed. Also choose a workspace
diretory to work in and the environment variable WS to this location. After that execute the
following commands (ignore emtpy lines and lines starting with #):
+To get started you first have to install Apache Celix. To do this you can download a source
release from the [download page](/celix/download.cgi) or checkout the latest version from
svn. For this getting started guide the latest trunk version is assumed. Choose a workspace
directory to work in and set the environment variable WS to this location. After that, execute
the following commands (ignore emtpy lines and lines starting with #):
 
 	#Create a new workspace to work in, e.g:
 	#mkdir ${HOME}/workspace
@@ -51,7 +51,6 @@ To get started you first have to install
 	#Note1 	if you want to change the install path add -DCMAKE_INSTALL_PREFIX=/opt/local
 	#Note2 	If you want to be able to edit all the available options, 
 	#		use the ccmake command instead of cmake, this will will present a ncursus based ui
-	#TODO check which bundles or on default. probably not shell & shell_tui...
 	cd celix-build
 	cmake ../celix-src
 	make all 
@@ -65,11 +64,11 @@ Download the latest eclipse CDT at [www.
 
 	
 ##Apache Celix Bundle project
-Now that Apache Celix and Eclipse is installed, we are ready to create a new Apache Celix
Bundle project. In this project cmake will be create a singe hello world bundle with a deployment
configurtion for testing the bundle.
+Now that Apache Celix and Eclipse is installed, we are ready to create a new Apache Celix
Bundle project. In this project cmake will be create a singe hello world bundle with a deployment
configuration for testing the bundle.
 
 For Apache Celix and an Apache Celix Bundle project CMake is used as build system. CMake
is a cross platform build. This getting started guide will only shows a small part of CMake,
for a more detailed introduction on CMake consult the [CMake documentation](http://www.cmake.org/documentation).

 
-The installation of Apache Celix, also added additional CMake files to extend the default
functionality of CMake in order to support the creating and testing of Apache Celix Bundles.

+The installation of Apache Celix, added additional CMake files to extend the default functionality
of CMake in order to support the creating and testing of Apache Celix Bundles. 
 
 To setup of the project, first create a new project dir to work in:
 	
@@ -77,7 +76,7 @@ To setup of the project, first create a
 	cd ${WS}/myproject
 	
 
-Then create a CMakeLists.txt file, the Makefile variant of CMake, in project root directory:
+Then create a CMakeLists.txt file - the makefile variant of CMake -in project root directory:
 	
 	#${WS}/myproject/CMakeLists.txt
 	
@@ -130,9 +129,9 @@ And add the following CMakeList.txt file
 		SOURCES(private/src/activator)
 	)	
 	
-This CMakeLists.txt file declares that a bundle should be build based on the build result
(shared library) of the declared sources (in this caese the private/src/activator.c source)
in the bundle marcro (The bundle marcro is an Apache Celix specific CMake extension). Also
the version, symbolicname (unique name) and name to be used when creating the bundle is declared.
+This CMakeLists.txt file declares that a bundle should be build based on the build result
(shared library) of the declared sources (in this caese the private/src/activator.c source).
The bundle marcro is an Apache Celix specific CMake extension. Also the version, symbolicname
(unique name) and name to be used when creating the bundle is declared.
 
-The last part for the hello_world bundle is the bundle activator source. The bundle activator
is the entry point for an Apache Celix Bundle. Think of the bundle activator as the main function
for an bundle, whith the difference that is not only control the start of a bundle, but also
the stoppoing of a bundle. 
+The last part for the hello_world bundle is the bundle activator source. The bundle activator
is the entry point for an Apache Celix Bundle. Think of the bundle activator as the main function
for a bundle, whith the difference that is does not only control the start of a bundle, but
also the stopping of a bundle. 
 
 Creating/starting and stopping/destroying is seperated in bundle activator. This is done
to make a clear seperation between the instantion/creation of a structure (e.g. object) and
exposure of that instantation to other parts of the program. The same, but then reserve hold
for seperating stopping and destroying a bundle. 
 
@@ -193,18 +192,21 @@ Hopefully you will some some build resul
 
 To create a deployment for the hello_world bundle two things are needed: 
 	
-1. Add a deploy.cmake in the bundles/hello_world dir declaring what to deploy and under which
name.
-2. Append the deploy_targets() marco call to the end of the root CMakeLists.txt file (${WS}/myproject/CMakeLists.txt).
This marcro will look for deploy.cmake files, parse them and when make is runned create the
actual deployment structure. 
+1. Add a `deploy.cmake` in the `bundles/hello_world` dir declaring what to deploy and under
which name.
+2. Append the deploy_targets() marco call to the end of the root `CMakeLists.txt` file (`${WS}/myproject/CMakeLists.txt`).
This marcro will look for deploy.cmake files, parse them and when make is runned create the
actual deployment structure. 
 
 
-	${WS}/myproject/bundles/hello_world/deploy.cmake
-	deploy("myproject" BUNDLES 
-		${CELIX_BUNDLES_DIR}/shell.zip 
-		${CELIX_BUNDLES_DIR}/shell_tui.zip
-		hello_world
-	)
+
+
+
+		${WS}/myproject/bundles/hello_world/deploy.cmake
+		deploy("myproject" BUNDLES 
+			${CELIX_BUNDLES_DIR}/shell.zip 
+			${CELIX_BUNDLES_DIR}/shell_tui.zip
+			hello_world
+		)
 	
-After the deploy.cmake is created and the root CMakeLists.txt is updated, rerun make again
form the  build project. the make files genereated by CMake will ensure cmake is runned again
to update the actual make files.
+After the deploy.cmake is created and the root `CMakeLists.txt` is updated, rerun make again
form the  build project. the make files genereated by CMake will ensure cmake is runned again
to update the actual make files.
 
 	cd ${WS}/myproject-build
 	make
@@ -214,7 +216,7 @@ Now a deploy directory myproject should
 	cd ${WS}/myproject-build/deploy/myproject
 	sh run.sh
 
-The hello_world bundle should be started and the famous "Hello World" text should be printed.
The shell and shell_tui bundle are also deployed and these can be used to query and control
the running. Below the commands to show which bundles are installed, how to print all known
shell commands and how to get help information for specific help command and how to stop the
a bundles (bundle 0 is the framework bundle) is shown:
+The hello_world bundle should be started with the famous "Hello World" text printed. The
shell and shell_tui bundle are also deployed and these can be used to query and control the
running framework. Below some commands are shown for printed the installed bundles, printing
all known shell command, printing help of a specific command and stopping a specific bundle
(note that bundle 0 is the framework):
 
 	ps 
 	help
@@ -223,25 +225,26 @@ The hello_world bundle should be started
 	
 
 ##Apache Celix Bundle Project in Eclipse
-TODO explain:
 
- - eclipse setup (cmake -G)
- - project structure (e.g where are my sources)
- - building with make from eclipse
- - running/debugging from eclipse
- 
- 
+A nice feature of CMake is the ability to generate Eclipse project files, with this feature
bundles can also be developed with use of Eclipse. This should help speed up the development
process. 
+To get started change directory to the build directory and generate a eclipse project file.
 
+	cd ${WS}/myproject-build 
+	cmake -G "Eclipse CDT4 - Unix Makefiles" .
+	
+Startup the Eclipse EDI and a chose the `${WS}`
+
+	![image](getting_started_img1.png)
+
+Import the project with existing project. 
 
-##The Next Steps
+	![image](getting_started_img2.png)
 
-TODO
-explain:
+To build the project, use Project->Build All. To run or debug from Eclipse navigate to
the myproject deploy directory and right click on the 'myproject.launch' file. And select
Run As or Debug As to run or debug the bundle.
+
+	![image](getting_started_img3.png) 
+ 
 
- - service registration/lookup
- - service tracker
- - bundle with private & public libs
- - bundle reusing existing libs as private and/or public
  
  
 

Added: celix/site/trunk/content/documentation/getting_started_img1.png
URL: http://svn.apache.org/viewvc/celix/site/trunk/content/documentation/getting_started_img1.png?rev=1654888&view=auto
==============================================================================
Binary file - no diff available.

Propchange: celix/site/trunk/content/documentation/getting_started_img1.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: celix/site/trunk/content/documentation/getting_started_img2.png
URL: http://svn.apache.org/viewvc/celix/site/trunk/content/documentation/getting_started_img2.png?rev=1654888&view=auto
==============================================================================
Binary file - no diff available.

Propchange: celix/site/trunk/content/documentation/getting_started_img2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: celix/site/trunk/content/documentation/getting_started_img3.png
URL: http://svn.apache.org/viewvc/celix/site/trunk/content/documentation/getting_started_img3.png?rev=1654888&view=auto
==============================================================================
Binary file - no diff available.

Propchange: celix/site/trunk/content/documentation/getting_started_img3.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream



Mime
View raw message