From 3ca229e04c8e1d3c58e7734572e27af7d45b3d08 Mon Sep 17 00:00:00 2001 From: dcnieho Date: Thu, 16 Jan 2014 02:07:29 +0000 Subject: [PATCH] Creade readme for git repo on github. git-svn-id: https://svn.code.sf.net/p/freeglut/code/trunk@1632 7f0cb862-5218-0410-a997-914c9d46530a --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f90d66 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +FreeGLUT +======== + +This readme file applies to the git clone of FreeGLUT's svn repo on [sourceforge.net](http://freeglut.sourceforge.net/) that is hosted on [github](https://github.com/dcnieho/FreeGLUT). This is provided here to enable user to contribute easier. + +Every effort is made to ensure that the ``git_master`` branch only progresses in a fastforward manner, but complete guarantees cannot be given as the [sourceforge.net trunk](https://sourceforge.net/p/freeglut/code/HEAD/tree/) is at all times leading. + +This copy of the svn repository was not created with ``git svn`` but with the excellent svn support of [SmartGit](http://www.syntevo.com/). Basic workflow upon receiving a pull request is as follows: +- Merge pull request on github +- pull in changes to my local clone of the ``git_master`` branch. +- cherry pick the merged commits onto my local clone of the ``svn/trunk`` branch +- push these commits to svn remote (this alters the commits in the local + ``svn/trunk`` clone as extra meta data is added) +- merge ``svn/trunk`` into local ``git_master`` +- push merge commit to github (its fast forward!) + +I will be unable to merge a pull request if the github clone is behind ``svn/trunk`` on srouceforge.net. Should you detect this, please contact me, maybe through making an issue here on github.