From e1cc68a3b0c0eb39a03258ad08b53a88b5f311e8 Mon Sep 17 00:00:00 2001 From: Michel Bats Date: Sat, 4 Nov 2023 18:28:37 +0100 Subject: [PATCH] Update readme to reflect the latest changes --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 34cf45b..25b7219 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,20 @@ -# Summary -The purpose of hg2git is to convert a Mercurial repository to a Git repository. +# hg2git + +Created by [Lionel Roche](https://github.com/lroche/hg2git) and updated by [Michel Bats](https://gitea.batssoft.nl/Michel/docker-hg2git) as there was no support for [repository format](https://wiki.mercurial-scm.org/MissingRequirement) sparse-revlog in the latest version published on [DockerHub](https://hub.docker.com/r/lroche/hg2git). + +The purpose of hg2git is to convert a Mercurial repository to a Git repository. All mechanism of conversion is based on [fast-export](https://github.com/frej/fast-export.git) tool. +## Launch conversion -# Launch conversion +```sh +docker compose up -d +``` - docker run -it -v ~/anyproject-hg:/work/projectname -v ~/project-result-git:/work/result lroche/hg2git projectname +The compose file uses two bind mount volumes, one for hg source, other for git target result. -or if you don't want to specifiy projectname: +Create the folder **project** and **result**. Use the project folder for your Mercurial repository, the converted git repository will be in the result folder. - docker run -it -v ~/anyproject-hg:/work/project -v ~/project-result-git:/work/result lroche/hg2git - - -the run uses two bound volumes, one for hg source, other for git target result. -the name of project has no matter but it will be the same between /work/projectname and the argument of the command (here projectname) - -# How to retrieve git conversion ? +## How to retrieve git conversion ? The result of git conversion can be found behind the /work/result volume - -