Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Clarify, merge, and format README/INSTALL #7

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions INSTALL

This file was deleted.

8 changes: 0 additions & 8 deletions README

This file was deleted.

39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# git-subtree

git-subtree allows subprojects to be included within a sub-directory of a main project, optionally including the sub-project's entire history.

## Installation

Choose **one** of the following ways to install git-subtree:

1. Copy the file `git-subtree.sh` to where all other git scripts are stored.
1. Run `install.sh` in a Git-enabled shell (that's "Git Bash" on Windows).
1. Run `make install` in a Cygwin-enabled shell.

Any *one* of these actions makes the `git subtree` command available (note: space instead of dash).

To additionally install the man page:

make doc
cp git-subtree.1 /usr/share/man/man1/


## Usage

See `git-subtree.txt` for details.

## Known issues

See `todo`.

## License

You may use this software under the terms of the GNU General Public License (GPL), Version 2.

See `COPYING`.

## Credits

Originally authored by Avery Pennarun, <http://apenwarr.ca/log>

Please do not contact the author using github mail. Instead, <mailto:[email protected]>
2 changes: 1 addition & 1 deletion git-subtree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ git-extensions repository in ~/git-extensions/:
name

You can omit the --squash flag, but doing so will increase the number
of commits that are incldued in your local repository.
of commits that are included in your local repository.

We now have a ~/git-extensions/git-subtree directory containing code
from the master branch of git://github.com/apenwarr/git-subtree.git
Expand Down
Empty file modified install.sh
100644 → 100755
Empty file.