From patchwork Mon Jul 23 07:04:29 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947623 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ysv62QSwz9s3Z for ; Mon, 23 Jul 2018 17:05:06 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ysv60NmNzDqrX for ; Mon, 23 Jul 2018 17:05:06 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.156.1; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ysv06nXVzDr0q for ; Mon, 23 Jul 2018 17:05:00 +1000 (AEST) Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N73xBG043416 for ; Mon, 23 Jul 2018 03:04:59 -0400 Received: from e06smtp02.uk.ibm.com (e06smtp02.uk.ibm.com [195.75.94.98]) by mx0a-001b2d01.pphosted.com with ESMTP id 2kd8xk2ydx-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:58 -0400 Received: from localhost by e06smtp02.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:44 +0100 Received: from b06cxnps3075.portsmouth.uk.ibm.com (9.149.109.195) by e06smtp02.uk.ibm.com (192.168.101.132) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:42 +0100 Received: from d06av24.portsmouth.uk.ibm.com (d06av24.portsmouth.uk.ibm.com [9.149.105.60]) by b06cxnps3075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74fg933095724 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:41 GMT Received: from d06av24.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 615E142056; Mon, 23 Jul 2018 10:04:57 +0100 (BST) Received: from d06av24.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1863242049; Mon, 23 Jul 2018 10:04:57 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av24.portsmouth.uk.ibm.com (Postfix) with ESMTP; Mon, 23 Jul 2018 10:04:57 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id BEF47A0270; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:29 +1000 X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> References: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072307-0008-0000-0000-0000025659E0 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-0009-0000-0000-000021BCC5B7 Message-Id: <20180723070431.565-4-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 4/6] README.md: Update installation instructions X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" Update the installation instructions in preparation for pushing a release to crates.io, which I intend to do very soon. Also clarify that snowpatch will only run on platforms that support both Rust and Git, because I'm not sure snowpatch will run bare-metal on a microcontroller. Signed-off-by: Andrew Donnellan --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 52e3f833f181..f69402635d4d 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,9 @@ creation of snowpatch. Installing ---------- -snowpatch is a [Rust](https://www.rust-lang.org) program. In order to compile -it, you will need Rust and its package manager, Cargo. snowpatch should run -on any target that Rust compiles on, however it has only been tested on Linux. +snowpatch is a [Rust](https://www.rust-lang.org) program. In order to compile +it, you will need Rust and its package manager, Cargo. snowpatch should run on +any target that supports Rust and Git, however it has only been tested on Linux. We do not provide pre-built binaries at this stage. ### Non-Rust dependencies @@ -59,11 +59,17 @@ We do not provide pre-built binaries at this stage. * [OpenSSL](https://www.openssl.org) headers * [OpenSSH](https://www.openssh.com) headers -### Building +### Installing with cargo -snowpatch can be compiled with `cargo build --release`, which will -download and build the Rust packages we depend on. The executable can -be found in `target/release/snowpatch`. +To install the latest tagged release of snowpatch using cargo, run `cargo +install snowpatch`, which will download and compile snowpatch and all its Rust +dependencies. The snowpatch binary will be installed as `snowpatch`. + +### Building manually + +To compile snowpatch manually, clone the git repository and run `cargo build +--release`. The executable can be found in `target/release/snowpatch` or +executed using `cargo run`. Contributing