aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorCédric Picard <cedric.picard@efrei.net>2015-11-30 16:53:03 +0100
committerCédric Picard <cedric.picard@efrei.net>2015-11-30 16:53:03 +0100
commit2a2e539137572c3a1fedf0aba0b60adcf112c84c (patch)
tree4f78dc5122d77667ed974da6d944e6cebd7e80d9 /README.rst
parentf45f9b884b1855e46414cd5f8d2362a0aa6f04b7 (diff)
downloadbulkrename-2a2e539137572c3a1fedf0aba0b60adcf112c84c.tar.gz
bulkrename-2a2e539137572c3a1fedf0aba0b60adcf112c84c.tar.bz2
bulkrename-2a2e539137572c3a1fedf0aba0b60adcf112c84c.zip
Readme is now officially rst
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..1506d14
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,34 @@
+Description
+===========
+
+Bulkrename allows you to pipe a list of filenames and to rename them
+interactively within your editor. It is inspired by ranger's bulkrename
+command (see http://nongnu.org/ranger/).
+
+Why ?
+=====
+
+When dealing with a great number of files, or having the same modification to
+do a lot of time it it often easier to do it in our well-known editor.
+
+Documentation
+=============
+
+Just pipe a list of files to bulkrename.
+
+If your $EDITOR environment variable is not set, vi will be called.
+
+License
+=======
+
+The code is under the WTFPL (see http://www.wtfpl.net/) mainly because I
+wanted to stay at 42 lines of code and the GPLv3 was too long.
+
+Contact
+=======
+
+::
+
+ Main developper: Cédric Picard
+ Email: cedric.picard@efrei.net
+ GPG: 383A 76B9 D68D 2BD6 9D2B 4716 E3B9 F4FE 5CED 42CB