[jira] [Commented] (OPENNLP-1621) Add a README to the root of the Sandbox projects

[ASF GitHub Bot (Jira)]

    [ 
https://issues.apache.org/jira/browse/OPENNLP-1621?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17888229#comment-17888229
 ] 

ASF GitHub Bot commented on OPENNLP-1621:
-----------------------------------------

mawiesne commented on code in PR #172:
URL: https://github.com/apache/opennlp-sandbox/pull/172#discussion_r1795183839


##########
README.md:
##########
@@ -0,0 +1,114 @@
+<!--
+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 OpenNLP!
+===========
+
+[![Build 
Status](https://github.com/apache/opennlp-sandbox/workflows/Java%20CI/badge.svg)](https://github.com/apache/opennlp-sandbox/actions)
+[![Contributors](https://img.shields.io/github/contributors/apache/opennlp-sandbox)](https://github.com/apache/opennlp-sandbox/graphs/contributors)
+[![GitHub pull 
requests](https://img.shields.io/github/issues-pr-raw/apache/opennlp-sandbox.svg)](https://github.com/apache/opennlp-sandbox/pulls)
+[![Stack 
Overflow](https://img.shields.io/badge/stack%20overflow-opennlp-f1eefe.svg)](https://stackoverflow.com/questions/tagged/opennlp)
+
+The Apache OpenNLP library is a machine learning based toolkit for the 
processing of natural language text.
+
+This sandbox of the toolkit is written mostly in Java and provides support for 
special NLP tasks, such as 
+word sense disambiguation, coreference resolution, text summarization, and 
more!
+These tasks are usually required to build text processing services.
+
+The goal of the OpenNLP sandbox is to provide extra components, potentially in 
an experimental stage.
+
+OpenNLP sandbox code can be used both programmatically through its Java API, 
some components even from a terminal through its CLI.
+
+## Useful Links
+
+For additional information, visit the [OpenNLP Home 
Page](http://opennlp.apache.org/)
+
+You can use OpenNLP with any language, demo models are provided 
[here](http://opennlp.sourceforge.net/models-1.5/).

Review Comment:
   Note: README for OpenNLP-tools (core project) requires that change as well.
   
   @jzonthemtn @rzo1 





> Add a README to the root of the Sandbox projects
> ------------------------------------------------
>
>                 Key: OPENNLP-1621
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-1621
>             Project: OpenNLP
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.4.0
>            Reporter: Martin Wiesner
>            Assignee: Martin Wiesner
>            Priority: Minor
>             Fix For: 2.4.1
>
>




--
This message was sent by Atlassian Jira
(v8.20.10#820010)