Repository: logging-log4j-scala Updated Branches: refs/heads/master 07d9e72ac -> bcb3fecb7
Add build information Project: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/commit/bcb3fecb Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/tree/bcb3fecb Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/diff/bcb3fecb Branch: refs/heads/master Commit: bcb3fecb7f19583dab0d5b3419174f357e78c0f4 Parents: 07d9e72 Author: Mikael Ståldal <mikael.stal...@magine.com> Authored: Fri Apr 21 10:12:35 2017 +0200 Committer: Mikael Ståldal <mikael.stal...@magine.com> Committed: Fri Apr 21 10:12:35 2017 +0200 ---------------------------------------------------------------------- BUILDING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/bcb3fecb/BUILDING.md ---------------------------------------------------------------------- diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..c71a40a --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,44 @@ +<!--- + 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 Log4j 2 Scala API + +To build Log4j 2 Scala API, you need a JDK implementation version 1.8 or greater and Apache Maven. +Note that building the site requires Maven 3.0.5, while everything else works fine with any version of Maven 3. + +To perform the license release audit, a.k.a. "RAT check", run. + + mvn apache-rat:check + +To install the jars in your local Maven repository, from a command line, run: + + mvn clean install + +Next, to build the site: + + mvn site + +On Windows, use a local staging directory, for example: + + mvn site:stage-deploy -DstagingSiteURL=file:///%HOMEDRIVE%%HOMEPATH%/log4j-scala + +On UNIX, use a local staging directory, for example: + + mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j-scala + +To test, run: + + mvn clean install
