Merge tag 'v2.3.10' into testing

[cc0/argeo-build.git] / README

diff --git a/README b/README
index 98eda7759e6e053c613bd51c055a8418c286eee4..6ce9473863a29cde4499fef9b0199a7b0bd13de1 100644 (file)
--- a/README
+++ b/README
@@ -5,10 +5,10 @@ It is NOT meant as a generic Java build system.
 ## Components
 Argeo Build depends on the Eclipse ECJ Java compiler, and on the BND Tools library for OSGi metadata generation (and therefore on SLF4j).
 
-- osgi.mk                      is included in the root Makefile of the layer being built
-- configure                    configures a build environment
-- Make.java                    compiles Java code and creates OSGi bundles based on the bnd.bnd file of each project within the layer
-- Repackage.java       downloads and repackages as OSGi bundles Maven artifacts or Eclipse releases (cf. Argeo TP)
+- osgi.mk           is included in the root Makefile of the layer being built
+- configure         configures a build environment
+- Make.java         compiles Java code, creates OSGi bundles based on the bnd.bnd file in each project
+- Repackage.java    downloads and repackages as OSGi bundles Maven artifacts or Eclipse releases (cf. Argeo TP)
 
 ## Usage
 For example usage, look at one of the core Argeo layers (typically Argeo Commons) on http://git.argeo.org :
@@ -17,9 +17,19 @@ git clone http://git.argeo.org/lgpl/argeo-commons.git --recursive
 export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64/
 ./argeo-commons/configure
 cd argeo-commons
-make clean all manifests
+make clean all
 
-Argeo Build will be installed as a git submodule under ./sdk/argeo-build/.
+Argeo Build is installed as a git submodule under
+./sdk/argeo-build/
+
+In order to configure a new project, copy the file
+configure.template
+from this directory as
+configure
+at the root of the project, and make it executable:
+chmod +x configure
+git --chmod +x configure
 
 ## Licensing
-This code is in the public domain under the CC0 v1.0 license, so that it can be used in any context by Argeo (or anyone else).
\ No newline at end of file
+This code is in the public domain under the CC0 v1.0 license,
+so that it can be used in any licensing context by Argeo or anyone else.
\ No newline at end of file