diff --git a/README.md b/README.md index e1f2a81..00f8cb3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # Hadoop Migration Assessment Tools +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -This repository contains tools to enable Hadoop users in collecting required data for Migration Assessment service. +This repository contains tools to enable Hadoop users in collecting required data required by Migration Assessment service. ## License -Copyright 2022 Google LLC +Copyright 2022-2023 Google LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -18,28 +19,6 @@ 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. -## Building - -Install bazel: - -``` -sudo apt-get update -sudo apt-get install bazel -``` - -Build the dist zip files: - -``` -bazel build //dist:all -``` - -Zip files will be available under `bazel-bin/dist` directory. - -## Testing - -Run all tests: - -``` -bazel test //... -``` +## Contributing +Contributing instructions are available at the following locations: [link](docs/contributing.md). diff --git a/docs/contributing.md b/docs/contributing.md index 87917f8..b90c01e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -31,3 +31,34 @@ All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests. + +## Contributing to Logging Hook + +### Dependencies + +Install bazel: + +``` +sudo apt-get update +sudo apt-get install bazel +``` + +### Checkout and compile + +To check out and compile the logging hook use the following commands: + +``` +git clone https://github.com/google/hadoop-migration-assessment-tools.git +cd hadoop-migration-assessment-tools/ +bazel build //dist:all +``` + +Zip file will be available under `bazel-bin/dist` directory. + +### Testing + +Run all tests: + +``` +bazel test //... +```