Edit README and INSTALL notes

This commit is contained in:
Taro L. Saito 2011-06-20 14:31:16 +09:00
parent 5c5203f7d2
commit 206a6ba487
2 changed files with 22 additions and 5 deletions

17
INSTALL
View File

@ -9,11 +9,10 @@
* Maven 3.x http://maven.apache.org/
- Check mvn command can be run from your command line.
[Windows (32/64bit)]
[Windows (32-bit)]
* GNU make
* And also tar, curl, cp, rm, grep commands are needed. (I use Cygwin for building snappy-java in Windows)
[Windows (64-bit)]
* Download MinGW-w64 http://sourceforge.net/projects/mingw-w64/
* Set PATH to the following commands in the downloaded archive:
@ -30,6 +29,14 @@ NOTICE: Do not use the Cygwin version of MinGW-w64. It fails to build assemblies
To build x86 (32bit) dll using 64-bit Windows, use "make win32" target.
[Linux (32/64-bit)]
* gcc-4.5.x or higher is necessary because snappy-java uses -static-libstdc++ option.
[Mac]
* Install gcc, make, etc. included in Mac OS X install disk. (X Code)
* Install mercurial using Mac Porsts http://www.macports.org/
= Building snappy-java =
@ -38,3 +45,9 @@ $ make
A native library for your machine environment and a jar package target/snappy-java-(version).jar are produced in the target folder.
= Building native library =
$ make native
= Rebuild native library =
$ make clean-native native

10
README
View File

@ -1,3 +1,7 @@
This document is a copy of http://code.google.com/p/snappy-java/
---------------------------------------
The snappy-java is a Java port of the snappy http://code.google.com/p/snappy/, a fast compresser/decompresser (written in C++ developed by Google).
== Features ==
@ -58,7 +62,7 @@ Add the following dependency to your pom.xml:
<dependency>
<groupId>org.xerial.snappy</groupId>
<artifactId>snappy-java</artifactId>
<version>1.0.1-rc4</version>
<version>(version)</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
@ -94,7 +98,7 @@ If you are using Maven for your web application, set the dependency scope as 'pr
<dependency>
<groupId>org.xerial.snappy</groupId>
<artifactId>snappy-java</artifactId>
<version>1.0.1-rc4</version>
<version>(version)</version>
<scope>provided</scope>
</dependency>
}}}
@ -104,7 +108,7 @@ Snappy-java is developed by [http://www.xerial.org/leo Taro L. Saito]. Twitter
[usage]
* Add snappy-java-1.0.1.jar to your classpath
* Add snappy-java-(version).jar to your classpath
* Use the compress/decompress methods defined in org.xerial.snappy.Snappy class.
== Contributors ==