You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by ks...@apache.org on 2019/01/08 10:03:27 UTC
[arrow] branch master updated: ARROW-4188: [Rust] Move Rust README
to top level rust directory
This is an automated email from the ASF dual-hosted git repository.
kszucs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 2057859 ARROW-4188: [Rust] Move Rust README to top level rust directory
2057859 is described below
commit 2057859744cb2ada93fc97838e09eb954963dc00
Author: Andy Grove <an...@gmail.com>
AuthorDate: Tue Jan 8 11:03:17 2019 +0100
ARROW-4188: [Rust] Move Rust README to top level rust directory
Author: Andy Grove <an...@gmail.com>
Closes #3342 from andygrove/ARROW-4188 and squashes the following commits:
fedcd7bc <Andy Grove> split README between top level and arrow level
b68f77cb <Andy Grove> Merge branch 'master' into ARROW-4188
e6dbd87f <Andy Grove> add badges back
f2ee7e05 <Andy Grove> Move Rust README to top level rust directory
---
rust/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
rust/arrow/README.md | 22 ----------------------
2 files changed, 50 insertions(+), 22 deletions(-)
diff --git a/rust/README.md b/rust/README.md
new file mode 100644
index 0000000..8fe7885
--- /dev/null
+++ b/rust/README.md
@@ -0,0 +1,50 @@
+<!---
+ 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.
+-->
+
+# Native Rust implementation of Apache Arrow
+
+## The Rust implementation of Arrow consists of the following crates
+
+- Arrow [(README)](arrow/README.md)
+- Parquet [(README)](parquet/README.md)
+
+## Run Tests
+
+Parquet support in Arrow requires data to test against, this data is in a
+git submodule. To pull down this data run the following:
+
+```bash
+git submodule update --init
+```
+
+The data can then be found in `cpp/submodules/parquet_testing/data`.
+Create a new environment variable called `PARQUET_TEST_DATA` to point
+to this location and then `cargo test` as usual.
+
+## Code Formatting
+
+Our CI uses `rustfmt` to check code formatting. Although the project is
+built and tested against nightly rust we use the stable version of
+`rustfmt`. So before submitting a PR be sure to run the following
+and check for lint issues:
+
+```bash
+cargo +stable fmt --all -- --check
+```
+
diff --git a/rust/arrow/README.md b/rust/arrow/README.md
index cbfd4dd..9df2dd2 100644
--- a/rust/arrow/README.md
+++ b/rust/arrow/README.md
@@ -57,28 +57,6 @@ cargo run --example dynamic_types
cargo run --example read_csv
```
-## Run Tests
-
-Parquet support in Arrow requires data to test against, this data is in a
-git submodule. To pull down this data run the following:
-
-```bash
-git submodule update --init
-```
-
-The data can then be found in `cpp/submodules/parquet_testing/data`.
-Create a new environment variable called `PARQUET_TEST_DATA` to point
-to this location and then `cargo test` as usual.
-
-Our CI uses `rustfmt` to check code formatting. Although the project is
-built and tested against nightly rust we use the stable version of
-`rustfmt`. So before submitting a PR be sure to run the following
-and check for lint issues:
-
-```bash
-cargo +stable fmt --all -- --check
-```
-
# Publishing to crates.io
An Arrow committer can publish this crate after an official project release has