You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@any23.apache.org by le...@apache.org on 2014/11/15 00:52:21 UTC
[1/4] any23 git commit: Move readme to markdown
Repository: any23
Updated Branches:
refs/heads/master d40415a1e -> 5db11ef91
Move readme to markdown
Project: http://git-wip-us.apache.org/repos/asf/any23/repo
Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/6c018edc
Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/6c018edc
Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/6c018edc
Branch: refs/heads/master
Commit: 6c018edcbc5d8dc4fdd2c9aa95d28283476f3abe
Parents: d40415a
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Fri Nov 14 15:38:22 2014 -0800
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Fri Nov 14 15:38:22 2014 -0800
----------------------------------------------------------------------
README.md | 159 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 159 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/any23/blob/6c018edc/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..147981c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,159 @@
+
+ ::: :::: ::: ::: ::: :::::::: ::::::::
+ :+: :+: :+:+: :+: :+: :+: :+: :+: :+: :+:
+ +:+ +:+ :+:+:+ +:+ +:+ +:+ +:+ +:+
+ +#++:++#++: +#+ +:+ +#+ +#++: +#+ +#++:
+ +#+ +#+ +#+ +#+#+# +#+ +#+ +#+
+ #+# #+# #+# #+#+# #+# #+# #+# #+#
+### ### ### #### ### ########## ########
+
+Apache Anything To Triples (Any23) is a library and web service that extracts
+structured data in RDF format from a variety of Web documents.
+Any23 documentation can be found on the [website](http://any23.apache.org)
+
+# Distribution Content
+
+api Any23 library external API.
+core The library core codebase.
+csvutils A CSV specific package
+encoding Encoding detection library.
+mime MIME Type detection library.
+nquads NQuads parsing and serialization library.
+plugins Library plugins codebase (read plugins/README.txt for further details).
+service The library HTTP service codebase.
+src Packing of Any23 artifacts.
+test-resources Material relating to Any23 JUnit test cases.
+RELEASE-NOTES.txt File reporting main release notes for every version.
+LICENSE.txt Applicable project license.
+README.md This file.
+
+# Online Documentation
+
+For details on the command line tool and web interface, see:
+ http://any23.apache.org/getting-started.html
+
+For a guide to using Any23 as a library in your Java applications, see:
+ http://any23.apache.org/developers.html
+
+Javadocs is available here:
+ http://any23.apache.org/apidocs/
+
+# Community
+
+You can reach our and connect with our community on our [mailing lists](http://any23.apache.org/mail-lists.html)
+
+# Build Any23 from Source Code
+
+The canonical Any23 source code lives at the [Apache Software Foundation Git repository](https://git-wip-us.apache.org/repos/asf/any23.git).
+
+Be sure to have the [Apache Maven v.3.x+](http://maven.apache.org/) installed and included in $PATH.
+
+## Clone the source:
+```
+git clone https://git-wip-us.apache.org/repos/asf/any23.git
+```
+## Navigate and build:
+```
+cd any23
+mvn clean install
+``
+From now on any23 is refered to as $ANY23_HOME`
+This will install the Any23 artifacts and its dependencies in your
+local Maven3 repository.
+You can then extract the compiled code and use the command line interface
+Please note you will need to change the version to the tar or zip you are extracting.
+```
+tar -zxvf $ANY23_HOME/core/target/apache-any23-core-${version-SNAPSHOT}.tar.gz
+```
+# Run the Any23 Commandline Tools
+
+Any23 comes with some command line tools. Within the directory you just extracted, you can invoke:
+Linux
+```
+$ANY23_HOME/core/target/apache-any23-core-${version-SNAPSHOT}/bin/any23 # Provides the main Any23 use case: metadata extraction on a file or URL source.
+```
+Windows
+```
+$ANY23_HOME/core/target/apache-any23-core-${version-SNAPSHOT}/bin/any23.bat # Provides the main Any23 use case: metadata extraction on a file or URL source.
+```
+The complete documentation about these tools can be found [here](http://any23.apache.org/getting-started.html)
+
+The bin scripts are generated dynamically during the package phase.
+To ensure the package generation, from the top level directory run:
+```
+mvn package
+```
+You can void extracting the archive files by going to the core generated bin folder
+```
+cd $ANY23_HOME/core/target/appassembler/bin/
+```
+and finally invoke the script for your OS (UNIX or Windows):
+
+ bin$ ./any23
+ [usage instructions will be printed out]
+
+# Run the Any23 Web Service
+
+Any23 can be run as a service.
+To run the Any23 service go to the service dir
+and then invoke the embedded Jetty server
+```
+cd $ANY23_HOME/service
+mvn jetty:run
+```
+You can check the service is running by accessing [http://localhost:8080/](http://localhost:8080/) with your browser.
+
+The complete documentation about this service can be found [here](http://any23.apache.org/getting-started.html)
+
+# Build the Any23 Web Service WAR
+
+The Any23 Service WAR by default will be generated as self-contained, all the dependencies will be included as JAR within the WEB-INF/lib archive dir.
+
+To generate the self contained WAR invoke from the service dir:
+```
+service$ mvn [-o] [-Dmaven.test.skip=true] clean package
+```
+Where -o will build the process offline, and -Dmaven.test.skip=true
+will force the test skipping.
+
+The WAR will be generated in
+```
+$ANY23_HOME/service/target/any23-service-x.y.z-SNAPSHOT.war
+```
+To produce a instead a WAR WITHOUT the included JAR dependencies it is possible to use
+the war-without-deps profile:
+```
+any23-service$ mvn [-o] [-Dmaven.test.skip=true] clean package
+```
+The option [-o] will speed up the module build if you have already
+collected all the required dependencies.
+
+The option [-Dmaven.test.skip=true] will disable tests.
+
+Again the various versions of the WAR will be generated into
+```
+$ANY23_HOME/service/target/apache-any23-service-x.y.z-*
+```
+
+# Generate the Documentation
+
+To generate the project site locally execute the following command from $ANY23_HOME:
+```
+cd $ANY23_HOME
+MAVEN_OPTS='-Xmx1024m' mvn [-o] clean site:site
+```
+You can speed up the site generation process specifying the offline option [-o],
+but it works only if all the involved plugin dependencies has been already downloaded
+in the local M2 repository.
+
+If you're interested in generating the Javadoc enriched with navigable UML graphs, you can activate
+the umlgraphdoc profile. This profile relies on [graphviz](http://www.graphviz.org/) that must be
+installed in your system.
+```
+cd $ANY23_HOME
+MAVEN_OPTS='-Xmx1024m' mvn -P umlgraphdoc clean site:site
+```
+
+# Munging of Any23 code to ASF
+
+When it was [decided](http://wiki.apache.org/incubator/Any23Proposal) that the Any23 code be brought into the Apache Incubator, the existing code was migrated over to the ASF infrastructure and documented/managed via a number of Jira tickets e.g, [INFRA-3978](https://issues.apache.org/jira/browse/INFRA-3978) [INFRA-4146](https://issues.apache.org/jira/browse/INFRA-4146) and [ANY23-29](https://issues.apache.org/jira/browse/ANY23-29).
[3/4] any23 git commit: Update README.md
Posted by le...@apache.org.
Update README.md
Project: http://git-wip-us.apache.org/repos/asf/any23/repo
Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/c10b9eb2
Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/c10b9eb2
Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/c10b9eb2
Branch: refs/heads/master
Commit: c10b9eb28b7d96f326541a072a3e3a0897b4adbf
Parents: 393395c
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Fri Nov 14 15:50:29 2014 -0800
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Fri Nov 14 15:50:29 2014 -0800
----------------------------------------------------------------------
README.md | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/any23/blob/c10b9eb2/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4cba2bf..fea34ef 100644
--- a/README.md
+++ b/README.md
@@ -13,19 +13,19 @@ Any23 documentation can be found on the [website](http://any23.apache.org)
# Distribution Content
- * api Any23 library external API.
- * core The library core codebase.
- * csvutils A CSV specific package
- * encoding Encoding detection library.
- * mime MIME Type detection library.
- * nquads NQuads parsing and serialization library.
- * plugins Library plugins codebase (read [plugins/README.txt](https://github.com/lewismc/any23/blob/master/plugins/README.md) for further details).
- * service The library HTTP service codebase.
- * src Packing of Any23 artifacts.
- * test-resources Material relating to Any23 JUnit test cases.
- * RELEASE-NOTES.txt File reporting main release notes for every version.
- * LICENSE.txt Applicable project license.
- * README.md This file.
+ * [api](https://github.com/lewismc/any23/tree/master/api): Any23 library external API.
+ * [core](https://github.com/lewismc/any23/tree/master/core): The library core codebase.
+ * [csvutils](https://github.com/lewismc/any23/tree/master/csvutils): A CSV specific package
+ * [encoding](https://github.com/lewismc/any23/tree/master/encoding): Encoding detection library.
+ * [mime](https://github.com/lewismc/any23/tree/master/mime): MIME Type detection library.
+ * [nquads](https://github.com/lewismc/any23/tree/master/nquads): NQuads parsing and serialization library.
+ * [plugins](https://github.com/lewismc/any23/tree/master/plugins): Library plugins codebase (read [plugins/README.txt](https://github.com/lewismc/any23/blob/master/plugins/README.md) for further details).
+ * [service](https://github.com/lewismc/any23/tree/master/service): The library HTTP service codebase.
+ * [src](https://github.com/lewismc/any23/tree/master/src): Packaging for Any23 artifacts.
+ * [test-resources](https://github.com/lewismc/any23/tree/master/test-resources): Material relating to Any23 JUnit test cases.
+ * [RELEASE-NOTES.txt](https://github.com/lewismc/any23/blob/master/RELEASE-NOTES.txt): File reporting main release notes for every version.
+ * [LICENSE.txt](https://github.com/lewismc/any23/blob/master/LICENSE.txt): Applicable project license.
+ * README.md: This file.
# Online Documentation
[2/4] any23 git commit: Update README.txt
Posted by le...@apache.org.
Update README.txt
Project: http://git-wip-us.apache.org/repos/asf/any23/repo
Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/393395cb
Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/393395cb
Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/393395cb
Branch: refs/heads/master
Commit: 393395cb37df102c00e22726ce1334ab9895510a
Parents: 6c018ed
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Fri Nov 14 15:43:56 2014 -0800
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Fri Nov 14 15:43:56 2014 -0800
----------------------------------------------------------------------
README.md | 43 ++++++++++++++++++++-----------------------
1 file changed, 20 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/any23/blob/393395cb/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 147981c..4cba2bf 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+```
::: :::: ::: ::: ::: :::::::: ::::::::
:+: :+: :+:+: :+: :+: :+: :+: :+: :+: :+:
+:+ +:+ :+:+:+ +:+ +:+ +:+ +:+ +:+
@@ -6,37 +6,34 @@
+#+ +#+ +#+ +#+#+# +#+ +#+ +#+
#+# #+# #+# #+#+# #+# #+# #+# #+#
### ### ### #### ### ########## ########
-
+```
Apache Anything To Triples (Any23) is a library and web service that extracts
structured data in RDF format from a variety of Web documents.
Any23 documentation can be found on the [website](http://any23.apache.org)
# Distribution Content
-api Any23 library external API.
-core The library core codebase.
-csvutils A CSV specific package
-encoding Encoding detection library.
-mime MIME Type detection library.
-nquads NQuads parsing and serialization library.
-plugins Library plugins codebase (read plugins/README.txt for further details).
-service The library HTTP service codebase.
-src Packing of Any23 artifacts.
-test-resources Material relating to Any23 JUnit test cases.
-RELEASE-NOTES.txt File reporting main release notes for every version.
-LICENSE.txt Applicable project license.
-README.md This file.
+ * api Any23 library external API.
+ * core The library core codebase.
+ * csvutils A CSV specific package
+ * encoding Encoding detection library.
+ * mime MIME Type detection library.
+ * nquads NQuads parsing and serialization library.
+ * plugins Library plugins codebase (read [plugins/README.txt](https://github.com/lewismc/any23/blob/master/plugins/README.md) for further details).
+ * service The library HTTP service codebase.
+ * src Packing of Any23 artifacts.
+ * test-resources Material relating to Any23 JUnit test cases.
+ * RELEASE-NOTES.txt File reporting main release notes for every version.
+ * LICENSE.txt Applicable project license.
+ * README.md This file.
# Online Documentation
-For details on the command line tool and web interface, see:
- http://any23.apache.org/getting-started.html
+For details on the command line tool and web interface, see [here](http://any23.apache.org/getting-started.html)
-For a guide to using Any23 as a library in your Java applications, see:
- http://any23.apache.org/developers.html
+For a guide to using Any23 as a library in your Java applications, see [here](http://any23.apache.org/developers.html)
-Javadocs is available here:
- http://any23.apache.org/apidocs/
+Javadocs is available [here](http://any23.apache.org/apidocs/)
# Community
@@ -56,8 +53,8 @@ git clone https://git-wip-us.apache.org/repos/asf/any23.git
```
cd any23
mvn clean install
-``
-From now on any23 is refered to as $ANY23_HOME`
+```
+From now on the above directory **any23** is refered to as **$ANY23_HOME**
This will install the Any23 artifacts and its dependencies in your
local Maven3 repository.
You can then extract the compiled code and use the command line interface
[4/4] any23 git commit: Update README.md
Posted by le...@apache.org.
Update README.md
Project: http://git-wip-us.apache.org/repos/asf/any23/repo
Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/5db11ef9
Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/5db11ef9
Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/5db11ef9
Branch: refs/heads/master
Commit: 5db11ef91912056a36dd3b4eac234aa902ac890a
Parents: c10b9eb
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Fri Nov 14 15:51:53 2014 -0800
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Fri Nov 14 15:51:53 2014 -0800
----------------------------------------------------------------------
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/any23/blob/5db11ef9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index fea34ef..c380d4a 100644
--- a/README.md
+++ b/README.md
@@ -85,9 +85,10 @@ You can void extracting the archive files by going to the core generated bin fol
cd $ANY23_HOME/core/target/appassembler/bin/
```
and finally invoke the script for your OS (UNIX or Windows):
-
+```
bin$ ./any23
- [usage instructions will be printed out]
+```
+usage instructions will be printed out.
# Run the Any23 Web Service