From b7c2a91ccc9dabdde175585473eccf2f839bcea8 Mon Sep 17 00:00:00 2001 From: Ben Hutchings Date: Mon, 18 May 2020 13:57:10 +0100 Subject: README: List all the known direct dependencies and how to install them The Implementation system is currently just a short list of dependencies, and incorrectly says that support for all repository types needs to be installed. Expand it into a full list of dependencies, stating which of them are optional, and how to install each of them. Related to CodethinkLabs/lorry-controller#1. --- README | 48 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/README b/README index 1d4e535..e6ac568 100644 --- a/README +++ b/README @@ -21,11 +21,49 @@ You can find a lot of lorries to crib ideas from at . -Implementation --------------- +Dependencies +------------ -Lorry relies on git-svn, git-cvsimport, hg-fast-export, perl (for tarballs) and -bzr fast-export for the conversions. You need to have them installed. +Required: + +* **Python 3** + +* **Git** + +* **cliapp**: Can be installed as the `python3-cliapp` package in + Debian, or with: + + pip3 install https://gitlab.com/trovekube/cliapp/-/archive/cliapp-1.20180812.1/cliapp-cliapp-1.20180812.1.tar.gz + + or from the source at . + +* **PyYAML**: Can be installed from PyPI. or as the `python3-yaml` + package in Debian. + +Optional: + +* **bzr-fastimport**: Needed if you want to import Bazaar (bzr) + repositories. Can be installed as the `bzr-fastimport` package in + Debian. + +* **cmdtest**: Needed if you want to run the test suite. Can be + installed as the `cmdtest` package in Debian, or from the source at + . + +* **git-cvsimport**: Needed if you want to import CVS repositories. + Can be installed as the `git-cvs` package in Debian. + +* **git-svn**: Needed if you want to import Subversion (svn) + repositories. Can be installed as the `git-svn` package in Debian. + +* **hg-fast-export**: Needed if you want to import Mercurial (hg) + repositories. Can be installed from the source at + . + +* **OpenSSH**: The OpenSSH client is needed if you want to import or + push to repositories using the SSH protocol. + +* **Perl**: Needed if you want to import tarballs. Lorry file specification ------------------------ @@ -259,7 +297,7 @@ Tips Legal stuff ----------- -Copyright (C) 2013-2015 Codethink Limited +Copyright (C) 2013-2020 Codethink Limited This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -- cgit v1.2.1