You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by cz...@apache.org on 2016/05/07 00:26:47 UTC

svn commit: r1742679 - /felix/site/trunk/content/documentation/development/building-felix.mdtext

Author: cziegeler
Date: Sat May  7 00:26:47 2016
New Revision: 1742679

URL: http://svn.apache.org/viewvc?rev=1742679&view=rev
Log:
Bring building docs more up to date

Modified:
    felix/site/trunk/content/documentation/development/building-felix.mdtext

Modified: felix/site/trunk/content/documentation/development/building-felix.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/development/building-felix.mdtext?rev=1742679&r1=1742678&r2=1742679&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/development/building-felix.mdtext (original)
+++ felix/site/trunk/content/documentation/development/building-felix.mdtext Sat May  7 00:26:47 2016
@@ -1,7 +1,9 @@
 Title: Building Felix
 
-A basic start to checking-out and building Felix including all sub projects:
-1. Download and install the latest Maven 3 release.
-1. Check out or update the Felix trunk (i.e., `svn checkout http://svn.apache.org/repos/asf/felix/trunk felix`).
-1. Go to the top of the project and type: "mvn clean install" to build all sub projects.
-1. To run the newly built framework, cd into *main* and type "java \-jar bin/felix.jar".
+In most cases you might only be interested in one or two sub projects. However, you still might want to check out all sub projects in one go.
+
+To get started:
+
+- Most Apache Felix projects use Apache Maven as the build tool. Therefore, download and install the latest Apache Maven 3 release.
+- Check out or update the Felix trunk (i.e., `svn checkout http://svn.apache.org/repos/asf/felix/trunk felix`).
+- Go to sub project you're interested in and type: "mvn clean install" to build it. If this project is not using Maven, refer to the docs for the sub project on how to build it.



Re: svn commit: r1742679 - /felix/site/trunk/content/documentation/development/building-felix.mdtext

Posted by Carsten Ziegeler <cz...@apache.org>.
I've slightly changed the building felix docs, not really good.
One way of editing the docs is simply to check out
https://svn.apache.org/repos/asf/felix/site/trunk/content
edit the docs there and commit. You can then use the CMS to deploy
these, or if you get into problems using the CMS ask another committer
to do so

HTH

Regards
Carsten

Carsten Ziegeler wrote
> Author: cziegeler
> Date: Sat May  7 00:26:47 2016
> New Revision: 1742679
> 
> URL: http://svn.apache.org/viewvc?rev=1742679&view=rev
> Log:
> Bring building docs more up to date
> 
> Modified:
>     felix/site/trunk/content/documentation/development/building-felix.mdtext
> 
> Modified: felix/site/trunk/content/documentation/development/building-felix.mdtext
> URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/development/building-felix.mdtext?rev=1742679&r1=1742678&r2=1742679&view=diff
> ==============================================================================
> --- felix/site/trunk/content/documentation/development/building-felix.mdtext (original)
> +++ felix/site/trunk/content/documentation/development/building-felix.mdtext Sat May  7 00:26:47 2016
> @@ -1,7 +1,9 @@
>  Title: Building Felix
>  
> -A basic start to checking-out and building Felix including all sub projects:
> -1. Download and install the latest Maven 3 release.
> -1. Check out or update the Felix trunk (i.e., `svn checkout http://svn.apache.org/repos/asf/felix/trunk felix`).
> -1. Go to the top of the project and type: "mvn clean install" to build all sub projects.
> -1. To run the newly built framework, cd into *main* and type "java \-jar bin/felix.jar".
> +In most cases you might only be interested in one or two sub projects. However, you still might want to check out all sub projects in one go.
> +
> +To get started:
> +
> +- Most Apache Felix projects use Apache Maven as the build tool. Therefore, download and install the latest Apache Maven 3 release.
> +- Check out or update the Felix trunk (i.e., `svn checkout http://svn.apache.org/repos/asf/felix/trunk felix`).
> +- Go to sub project you're interested in and type: "mvn clean install" to build it. If this project is not using Maven, refer to the docs for the sub project on how to build it.
> 
> 
> 


 
-- 
Carsten Ziegeler
Adobe Research Switzerland
cziegeler@apache.org