diff --git a/ASSEMBLY.md b/ASSEMBLY.md index c967556..53012fd 100644 --- a/ASSEMBLY.md +++ b/ASSEMBLY.md @@ -15,6 +15,10 @@ that great emphasis was put on operating system interoperability and all scripts (build ones included) should conform to it. (i.e. if you implement automated builds in Linux, then make sure it/something works in Windows too :P). +Another thing to take care of is the line endings, since they are different in +*nix and Windows. Please make sure the shell script line endings are *nix specific +and the batch file line endings are Windows specific. + Distributable Package ------------------------- @@ -30,8 +34,8 @@ The structure of the distribution package is as follows: - repos // Empty folder for the git repositories - setup // Folder containing installation and configuration files - git // Setup files for installing git - - git.exe // Git for Windows\* installer - - git.pkg // Git package for Mac OS X\** + - git.exe // Git for Windows* installer + - git.pkg // Git package for Mac OS X** - git.sh // Git installer for *nix flavors - linux.sh // Git installer for Linux distributions - macos.sh // Git installer for Mac OS X @@ -45,7 +49,8 @@ in the case of Linux, a binary installer from the msysGit project should be also bundled with GitBox. As of writing, the latest stable Git for Windows installer can be downloaded from http://code.google.com/p/msysgit/downloads/list . If you bundle a newer version of Git for Windows than previously done, please make sure -it actually works. +it actually works. The name of the correct version to download has the form: +Git-a.b.c.d-previewYYYYMMDD.exe \** Git for Mac OS X: As in the case of Windows, installing git on Mac OS X is harder that it should be, so a binary package from the git-osx-installer project diff --git a/README.md b/README.md index 9c6e57b..ec12090 100644 --- a/README.md +++ b/README.md @@ -20,16 +20,28 @@ commands and paths. - Imporint an existing git repository into GitBox - Installation ----------------- + Planned Features +-------------------- -The project Wiki is under construction, in the mean time please check the -[User Manual](http://github.com/downloads/karalabe/gitbox/GitBox-0.1.0-UserManual.pdf) -available at the download section. + - Repository backup creation + - Repository merging + + + Installation and Usage +-------------------------- + +The [project's wiki](http://github.com/karalabe/gitbox/wiki) contains a +detailed [installation](http://github.com/karalabe/gitbox/wiki/Installing-GitBox), +page, a full [command reference](http://github.com/karalabe/gitbox/wiki/Command-Reference) +and a list of [samples and tutorials](http://github.com/karalabe/gitbox/wiki/Samples-and-Tutorials) +to get you started right away. + +All of these can also be found in the project's user manual available at the +[download](http://github.com/karalabe/gitbox/downloads) section. - Sample Usage ----------------- + Very Basic Sample Usage +--------------------------- From computer A: $ gitbox create myapp @@ -49,27 +61,25 @@ From computer A: // Do some work // ..... -Until the project Wiki will be completed, for a full list of supported commands, -check the [User Manual](http://github.com/downloads/karalabe/gitbox/GitBox-0.1.0-UserManual.pdf) -included both in the installation package and also downloadable from the -project's download page. +For more, please see the [samples and tutorials](http://github.com/karalabe/gitbox/wiki/Samples-and-Tutorials) +section in the wiki pages. Supported Platforms ----------------------- Fully supported: - - Fedora (not released yet) - - Mac OS X (not released yet) + - Fedora + - Mac OS X - OpenSuSE 11.1+ - - Ubuntu (not released yet) + - Ubuntu - Windows XP SP2+, Vista, Win 7 Partially supported: - Linux and *nix - Theoretically works. Requires manual git installation. - - Windows before XP SP2 - Check installation details in the user manual. + - Windows before XP SP2 - Requires manual configuration. Contributions diff --git a/docs/gitbox.docx b/docs/gitbox.docx index 7c88013..d56d682 100644 Binary files a/docs/gitbox.docx and b/docs/gitbox.docx differ diff --git a/gitbox.bat b/gitbox.bat index cfbdc0a..3ff5d96 100644 --- a/gitbox.bat +++ b/gitbox.bat @@ -86,23 +86,26 @@ if /i '%1'=='create' ( set repository="%repos%"\%2.git if not exist !repository! ( rem Create a new empty repository + echo Creating empty repository... md !repository! - git init --bare !repository! + git init --quiet --bare !repository! rem Since git doesn't like empty repos, place a README in there are save the user a lof of headaches + echo Initializing new repository... set checkout="%TEMP%"\%2 md !checkout! - git clone -o gitbox file://!repository! !checkout! + git clone --quiet --origin gitbox file://!repository! !checkout! 2>nul echo Enjoy your GitBox repository > !checkout!\README set pwd=%CD% cd /d !checkout! git add README - git commit -m "Created the repository" - git push gitbox master + git commit --quiet -m "Created the repository" 2>nul + git push --quiet gitbox master 2>nul cd /d !pwd! rmdir /s /q !checkout! + echo Repository successfully created. ) else ( echo A repository named "%2" is already tracked by GitBox. pause @@ -113,7 +116,9 @@ if /i '%1'=='clone' ( rem Clone the specified repository with the gitbox repo as the master set repository="%repos%"\%2.git if exist !repository! ( - git clone -o gitbox file://!repository! + echo Cloning repository... + git clone --quiet --origin gitbox file://!repository! + echo Repository successfully cloned. ) else ( echo GitBox couldn't find the repository named: %2 pause @@ -131,12 +136,15 @@ if /i '%1'=='import' ( rem Create a new empty repository set repository="%repos%"\%2.git if not exist !repository! ( + echo Creating empty repository... md !repository! - git init --bare !repository! + git init --quiet --bare !repository! rem Add an entry to the list of remote repositories and push to it + echo Importing data into new repository... git remote add gitbox file://!repository! - git push gitbox master + git push --quiet gitbox master + echo Repository successfully imported. ) else ( echo A repository named "%2" is already tracked by GitBox. pause diff --git a/misc/logo.svg b/misc/logo.svg new file mode 100644 index 0000000..633981f --- /dev/null +++ b/misc/logo.svg @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +