You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2018/09/04 16:27:09 UTC
[karaf-cave] branch master updated: Migrate the README and BUILDING
files to md
This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/karaf-cave.git
The following commit(s) were added to refs/heads/master by this push:
new 734138a Migrate the README and BUILDING files to md
734138a is described below
commit 734138a4f60a8d9483039fc6c00fcd7b8831d05a
Author: Jean-Baptiste Onofré <jb...@apache.org>
AuthorDate: Tue Sep 4 18:26:52 2018 +0200
Migrate the README and BUILDING files to md
---
BUILDING | 54 --------------------------------------
BUILDING.md | 54 ++++++++++++++++++++++++++++++++++++++
README => README.md | 74 +++++++++++++++++++++++++++++++----------------------
3 files changed, 97 insertions(+), 85 deletions(-)
diff --git a/BUILDING b/BUILDING
deleted file mode 100644
index d194d5a..0000000
--- a/BUILDING
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-Building Apache Karaf Cave
-==========================
-
-Initial Setup
--------------
-
-1) Install J2SE 7.0 SDK (or later), which can be downloaded from
- http://www.oracle.com/technetwork/java/javase/downloads.
-
-2) Make sure that your JAVA_HOME environment variable is set to the newly installed
- JDK location, and that your PATH includes %JAVA_HOME%\bin (windows) or
- $JAVA_HOME/bin (unix).
-
-3) Install Maven 3.0.3 (or later), which can be downloaded from
- http://maven.apache.org/download.html. Make sure that your PATH includes
- the MVN_HOME/bin directory.
-
-Building
---------
-
-1) Download and uncompress the Apache Karaf Cave source distribution.
-
-2) Change to the top level directory of Apache Karaf Cave uncompressed source distribution.
-
-3) Run
-
- $> mvn clean install
-
- This will compile Apache Karaf Cave and run all of the tests in the
- Apache Karaf Cave source distribution.
-
- $> mvn clean install -DskipTests
-
- This will compile Apache Karaf Cave without running the tests (faster).
-
-4) Apache Karaf Cave is now present in your local Maven repository. Read the README file
- to installl Cave into a running Apache Karaf instance.
diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..64c66a5
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,54 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Building Apache Karaf Cave
+
+Initial Setup
+-------------
+
+1. Install J2SE 7.0 SDK (or later), which can be downloaded from
+ http://www.oracle.com/technetwork/java/javase/downloads.
+2. Make sure that your JAVA_HOME environment variable is set to the newly installed
+ JDK location, and that your PATH includes `%JAVA_HOME%\bin` (windows) or
+ `$JAVA_HOME/bin` (unix).
+3. Install Maven 3.0.3 (or later), which can be downloaded from
+ http://maven.apache.org/download.html. Make sure that your PATH includes
+ the `MVN_HOME/bin` directory.
+
+## Building
+
+1. Download and uncompress the Apache Karaf Cave source distribution.
+2. Change to the top level directory of Apache Karaf Cave uncompressed source distribution.
+3. Run
+
+ ```
+ $> mvn clean install
+ ```
+
+ This will compile Apache Karaf Cave and run all of the tests in the
+ Apache Karaf Cave source distribution.
+
+ ```
+ $> mvn clean install -DskipTests
+ ```
+
+ This will compile Apache Karaf Cave without running the tests (faster).
+
+4. Apache Karaf Cave is now present in your local Maven repository. Read the README file
+ to installl Cave into a running Apache Karaf instance.
diff --git a/README b/README.md
similarity index 60%
rename from README
rename to README.md
index a70bf76..820b343 100644
--- a/README
+++ b/README.md
@@ -1,27 +1,34 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-Welcome to Apache Karaf Cave
-============================
-Apache Karaf Cave is an Apache Karaf subproject. It provides an implementation of the OSGi Repository specification, with
-additional feature such as a complete Maven repository support, a REST API for management, support of remote repository
-proxy.
-
-Cave deals with the requirements and capabilities of all artifacts.
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Karaf Cave
+
+Apache Karaf Cave is an Apache Karaf subproject. It provides a complete repository manager and deployer for Apache Karaf.
+
+## Overview
+
+Apache Karaf Cave supports:
+
+* Maven repository management
+* OSGi Repository management
+* Deployer on multiple Apache Karaf instances
+* Complete REST API and JMX MBeans
Apache Karaf Cave provides the following features:
* Storage: Cave includes a storage backend. The default one is a simple filesystem backend. As the Cave backend
@@ -32,25 +39,31 @@ repository storage.
* REST API: Cave provides a REST API to manipulate the repositories.
* Artifact Upload: Users can upload OSGi bundle in a Cave repository. It supports URLs like mvn:groupId/artifactId/version,
file:, http:, etc.
+* Deployer: to deploy and manage your "farm" of Apache Karaf instances.
* Repository proxy: Cave is able to proxy an existing repository, for instance an existing Maven repository.
The artifacts are located on the "external" repository, Cave handles the repository metadata. Cave supports file: and http:
URLs, it means that Cave is able to browse a remote HTTP Maven repository for instance.
* Repository population: Cave is able to get artifacts present on an "external" repository (local file: or
remote http:), looking for OSGi bundles, and copy the artifacts in the Cave repository storage.
+## Getting Started
-Getting Started
-===============
For an Apache Karaf Cave source distribution, please read
-BUILDING for instructions on building Apache Karaf Cave.
+BUILDING.md for instructions on building Apache Karaf Cave.
To install Apache Karaf Cave, first you have to register the Cave features descriptor:
+```
karaf@root()> feature:repo-add mvn:org.apache.karaf.cave/apache-karaf-cave/4.0.0/xml/features
+```
-Now, you can install the Cave feature simply by typing:
+Now, you can install the Cave simply by typing:
-karaf@root()> feature:install cave-server
+```
+karaf@root()> feature:install cave
+```
+
+## More Information
The PDF manual is the right place to find any information about Karaf Cave.
@@ -71,5 +84,4 @@ contribute, please see:
Many thanks for using Apache Karaf Cave.
-
-The Karaf Team
+**The Apache Karaf Team**