diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f3eb963 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include *.rst \ No newline at end of file diff --git a/README.markdown b/README.markdown deleted file mode 100644 index 67c64d3..0000000 --- a/README.markdown +++ /dev/null @@ -1,27 +0,0 @@ -Create an archive by using the `git ls-files --cached --full-name --no-empty-directory` command. Support sumodule trees regardless of depth. - -*License:* MIT - -*Usage:* `git-archive-all [-v] [--prefix PREFIX] [--no-exclude] [--force-submodules] [--extra] [--dry-run] OUTPUT_FILE` - -*Options:* - - **--version** Show program's version number and exit. - - **-h, --help** Show this help message and exit. - - **-v, --verbose** Enable verbose mode. - - **--prefix=PREFIX** Prepend PREFIX to each filename in the archive. OUTPUT_FILE name is used by default to avoid tarbomb. You can set it to '' in order to explicitly request tarbomb. - - **--no-exclude** Don't read .gitattributes files for patterns containing export-ignore attributes. - - **--force-submodules** Force a `git submodule init && git submodule update` at each level before iterating submodules - - **--extra** Include extra files to the resulting archive. - - **--dry-run** Don't actually archive anything, just show what would be done. - -Paid Support ------------- -If functional you need is missing but you're ready to pay for it, feel free to [contact me](mailto:kulakov.ilya@gmail.com?subject=New feature for git-archive-all). If not, create an issue anyway, I'll take a look as soon as I can. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..4996eb2 --- /dev/null +++ b/README.rst @@ -0,0 +1,27 @@ +Archive repository with all its submodules. + +:: + + git-archive-all [-v] [--prefix PREFIX] [--no-exclude] [--force-submodules] [--extra] [--dry-run] OUTPUT_FILE + + Options: + + --version Show program's version number and exit. + + -h, --help Show this help message and exit. + + -v, --verbose Enable verbose mode. + + --prefix=PREFIX Prepend PREFIX to each filename in the archive. OUTPUT_FILE name is used by default to avoid tarbomb. You can set it to '' in order to explicitly request tarbomb. + + --no-exclude Don't read .gitattributes files for patterns containing export-ignore attributes. + + --force-submodules Force a `git submodule init && git submodule update` at each level before iterating submodules + + --extra Include extra files to the resulting archive. + + --dry-run Don't actually archive anything, just show what would be done. + +Support +------- +If functional you need is missing but you're ready to pay for it, feel free to `contact me `_. If not, create an issue anyway, I'll take a look as soon as I can. diff --git a/setup.cfg b/setup.cfg index b897356..9b7063c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,4 +2,4 @@ universal = 1 [metadata] -description-file = README.markdown +description-file = README.rst