Update readme to reflect the latest changes

This commit is contained in:
2023-11-04 18:28:37 +01:00
parent 5997f047cf
commit e1cc68a3b0
+12 -14
View File
@@ -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