Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c050f5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# al32-mktorrent
+
+Torrent creation script for [ArchLinux32](https://archlinux32.org)
+
+## Usage
+
+ al32-mktorrent.sh [ -d date ] [ i686 | dual ]
+
+If no architecture is specified, the script will default to `i686`.
+If no date is specified, the script will prompt for a date during the process.
+
+## License
+
+> This program is free software: you can redistribute it and/or modify
+> it under the terms of the GNU General Public License as published by
+> the Free Software Foundation, either version 3 of the License, or
+> (at your option) any later version.
+>
+> This program is distributed in the hope that it will be useful,
+> but WITHOUT ANY WARRANTY; without even the implied warranty of
+> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+> GNU General Public License for more details.
+>
+> You should have received a copy of the GNU General Public License
+> along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+## Author
+
+Copyright (c) 2017 Simon Doppler (dopsi)