From e1225e5d332af7792e796d78513144d186efcebf Mon Sep 17 00:00:00 2001 From: "a.l.e" Date: Tue, 12 May 2015 20:20:10 +0200 Subject: [PATCH] revised README.md --- README | 49 -------------------------------------- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+), 49 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index f016050..0000000 --- a/README +++ /dev/null @@ -1,49 +0,0 @@ -README -====== - -This repository contains the meta-data used to convert the Scribus SVN -(svn://scribus.net) repository to Git. - -The trunk and all branches and tags are imported from SVN into Git. - -The SVN repository contains an additional folder "Scribus" at the -project root. This folder is skipped during conversion, so that the -programm sources appear in the repository root. - -The git_repo_init.sh script configures an empty Git repository to -receive the SVN commits. - -The update_from_svn.sh script pulls new commits from SVN, creates Git -tags from SVN tags and pushes the result to the configured "origin" -Git remote repository. - - -How to set-up -------------- - -1. create empty git repository - git init -2. move into the git repository - cd -3. initialize git svn - ./path/to/git_repo_init.sh -4. configure remote Git server - git remote add origin -5. import svn into git - ./path/to/update_from_svn.sh - - -Caveat ------- - -All SVN commiters need to be listed in svn_authors.txt. A missing -author will lead to an error: - - Author: not defined in /path/to/svn_authors.txt file - -In this case, add the new commiter to the svn_authors.txt file with -the following format: - - username = Full Name - -and re-run the import. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0b0e17 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# README + +This repository contains the meta-data used to convert the Scribus SVN +(svn://scribus.net) repository to Git. + +The trunk and all branches and tags are imported from SVN into Git. + +The SVN repository contains an additional folder "Scribus" at the +project root. This folder is skipped during conversion, so that the +programm sources appear in the repository root. + +The `git_repo_init.sh` script configures an empty Git repository to +receive the SVN commits. + +The `update_from_svn.sh` script pulls new commits from SVN, creates Git +tags from SVN tags and pushes the result to the configured "origin" +Git remote repository. + + +## How to set-up + +Each developer who takes care of synchronizing the Scribus Github repository with the Scribus SVN repository has to: + +1. Make sure you have git-svn installed (and git, for course). +2. Clone chitz' script's repository: + + git@github.com:chhitz/scribus_svn_git.git + +3. Use the provided scripts to initialize and update the repository. + +Once you have the scripts you: + +1. create empty git repository + + git init + +2. move into the git repository + + cd + +3. initialize git svn + + ./path/to/git_repo_init.sh + +4. configure remote Git server + + git remote add origin git@github.com:scribusproject/scribus.git + +5. import svn into git + + ./path/to/update_from_svn.sh + +git will start downloading files from the Scribus svn repository. It will take a long while for the first sync. + +## How to update + +Once you have synchronized the repository once, it's just a matter of running the `update_from_svn.sh` script from inside of the repository. + +## Caveat + +All SVN commiters need to be listed in `svn_authors.txt`. A missing +author will lead to an error: + + Author: not defined in /path/to/svn_authors.txt file + +In this case, add the new commiter to the `svn_authors.txt` file with +the following format: + + username = Full Name + +and re-run the import.