You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sdap.apache.org by rk...@apache.org on 2023/01/04 18:17:38 UTC

[incubator-sdap-nexusproto] branch release/1.0.0 updated: [SDAP-424] Update readme

This is an automated email from the ASF dual-hosted git repository.

rkk pushed a commit to branch release/1.0.0
in repository https://gitbox.apache.org/repos/asf/incubator-sdap-nexusproto.git


The following commit(s) were added to refs/heads/release/1.0.0 by this push:
     new cc35046  [SDAP-424] Update readme
cc35046 is described below

commit cc35046cd72d9e749a33b697c58e5ca9ccec5711
Author: Riley Kuttruff <72...@users.noreply.github.com>
AuthorDate: Wed Jan 4 10:17:34 2023 -0800

    [SDAP-424] Update readme
    
    Reflects Gradle wrapper exclusion from source distribution
---
 README.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 34bf7c7..965a6ff 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,18 @@
 
 This project contains the [protobuf](https://developers.google.com/protocol-buffers/) definition for a NexusTile. By compiling the protobuf specification, both Java and Python objects are generated.
 
-# Developer Installation
+# For Developers
 
-1. Run `./gradlew clean build install`
+## Prerequisites
+
+This project is build using Gradle. This repository contains a Gradle wrapper so, if building from the repository, no further action is needed; however, the Gradle wrapper is not included in the source distribution. If building from the source distribution, you will need to [install Gradle manually](https://gradle.org/releases/).
+
+## Developer Installation
+
+1. Build source:
+
+    - If building from repository: run `./gradlew clean build install`
+    - If building from source distribution: run `gradle clean build install`
 
 2. cd into `/build/python/nexusproto`