summaryrefslogtreecommitdiff
path: root/support/pkgcheck/quick_intro.txt
diff options
context:
space:
mode:
Diffstat (limited to 'support/pkgcheck/quick_intro.txt')
-rw-r--r--support/pkgcheck/quick_intro.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/support/pkgcheck/quick_intro.txt b/support/pkgcheck/quick_intro.txt
new file mode 100644
index 0000000000..ae2d1a4dea
--- /dev/null
+++ b/support/pkgcheck/quick_intro.txt
@@ -0,0 +1,24 @@
+
+You want to check your package before uploading to CTAN?
+
+
+1. Build the zip archive
+
+2. Make sure your umask is set to 022
+
+3. Assuming your package's name is mypkg and your zip archive is mypkg.zip
+
+ Unpack mypkg.zip (which should contain a top level directory mypkg/),
+ so that you obtain again a directory mypkg/ containing the files of your package.
+
+ unzip mypkg.zip
+
+ Now run `pkgcheck`
+
+ `pkgcheck -d mypkg`
+
+
+If you want to check URLs in README file run
+
+ `pkgcheck --urlcheck -d mypkg`
+