Skip to content

Commit

Permalink
Migrate README to rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kentzo committed Sep 1, 2016
1 parent 34dfbd7 commit e78b955
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 28 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include *.rst
27 changes: 0 additions & 27 deletions README.markdown

This file was deleted.

27 changes: 27 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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 <mailto:[email protected]?subject=git-archive-all>`_. If not, create an issue anyway, I'll take a look as soon as I can.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
universal = 1

[metadata]
description-file = README.markdown
description-file = README.rst

0 comments on commit e78b955

Please sign in to comment.