You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2020/05/21 16:50:32 UTC
[incubator-datasketches-memory] branch Readme created (now 6a64af1)
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a change to branch Readme
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-memory.git.
at 6a64af1 Update Readme
This branch includes the following new commits:
new 6a64af1 Update Readme
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org
[incubator-datasketches-memory] 01/01: Update Readme
Posted by le...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch Readme
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-memory.git
commit 6a64af17e8444ca812e1a0f366130f24a7a1a877
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Thu May 21 09:49:45 2020 -0700
Update Readme
---
README.md | 41 +++++++----------------------------------
1 file changed, 7 insertions(+), 34 deletions(-)
diff --git a/README.md b/README.md
index 5a2e16b..31a6874 100644
--- a/README.md
+++ b/README.md
@@ -25,41 +25,21 @@
=================
-# DataSketches Memory Component
+# DataSketches Java Memory Component
The goal of this component of the library is to provide high performance access to native memory for primitives
and primitive arrays. It also provides consistent views into heap-based primitive arrays,
Java ByteBuffers and memory mapped files. This package is general purpose, has minimal external
runtime dependencies and can be used in any application that needs to manage data structures outside
the Java heap.
-## Documentation
+Please visit the main [DataSketches website](https://datasketches.apache.org) for more information.
-### [DataSketches Library Website](https://datasketches.apache.org/)
+If you are interested in making contributions to this site please see our [Community](https://datasketches.apache.org/docs/Community/) page for how to contact us.
-### [Memory Package Overview Documentation](https://datasketches.apache.org/docs/Memory/MemoryPackage.html)
-
-### [Memory Package Performance](https://datasketches.apache.org/docs/Memory/MemoryPerformance.html)
-
-### [Memory JavaDocs](https://datasketches.apache.org/api/memory/snapshot/apidocs/index.html)
-
-## Downloading Latest Release
-__NOTE:__ This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory
- must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements.
-
-This is required by the Oracle Java Specification in order to ensure location-independent
- access to resources: [See Oracle Location-Independent Access to Resources](https://docs.oracle.com/javase/8/docs/technotes/guides/lang/resources.html)
-
-### [Zip File from www.apache.org/dist](http://www.apache.org/dist/incubator/datasketches/memory/)
-
-### [Jar Files from Maven Central](https://repository.apache.org/content/repositories/releases/org/apache/datasketches/datasketches-memory/)
-
-### [GitHub](https://github.com/apache/incubator-datasketches-memory/releases)
-
-## Downloading Earlier Releases
-
-### [Zip File from archive.apache.org/dist](http://archive.apache.org/dist/incubator/datasketches/memory/)
+---
## Build Instructions
+__NOTE:__ This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements. This is required by the Oracle Java Specification in order to ensure location-independent access to resources: [See Oracle Location-Independent Access to Reso [...]
### JDK8 is required to compile
This DataSketches component is pure Java and you must compile using JDK 8.
@@ -99,13 +79,6 @@ There is one run-time dependency:
#### Testing
See the pom.xml file for test dependencies.
-## How to Contact Us
-* We have two ASF [the-ASF.slack.com](http://the-ASF.slack.com) slack channels:
- * datasketches -- general user questions
- * datasketches-dev -- similar to our Apache [Developers Mail list](https://lists.apache.org/list.html?dev@datasketches.apache.org), except more interactive, but not as easily searchable.
-
-* For bugs and performance issues: [Issues for datasketches-memory](https://github.com/apache/incubator-datasketches-memory/issues)
-
-* For general questions about using the library please subscribe: [Users Mail List](https://lists.apache.org/list.html?users@datasketches.apache.org)
+----
-* If you are interested in contributing please subscribe: [Developers Mail list](https://lists.apache.org/list.html?dev@datasketches.apache.org)
+Disclaimer: Apache DataSketches is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate [...]
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org