summaryrefslogtreecommitdiff
path: root/support/ctan_chk/README
blob: 30620a61d6d102248c7af22f4ae026e9f2cff822 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

Project:                   Ctan guidelines verifier and corrector program for uploading projects
Distributed under license: GNU General Public License (version 3).
Distribution Date:         15 Feb. 2015
Distribution version:      1.0
Comments:                  Currently for the Unix flavoured Platforms running Gawk
Author:                    Dave Bone

Contributors list:
  Dave Bone


Basic Gawk program that uses Ctan's published guidelines for authors to help eliminate slopiness in uploaded files/project.
It is completely open for users to program additional guidelines and Ctan's future  adjustments. 
The program came about when I first attempted to upload ``Yacco2'' for Ctan consideration.
As Yacco2 was quite large, it took me 3 attempts to clean up my project.
Depending on how u develop your project, in my case the Yacco2 project for Ctan upload is a subset of the complete system
and so each uplift required the guideline assessment/purging process.

This is my attempt to help both the author in getting the new system in shape for Ctan uplift 
and to lower the Ctan volanteers interaction to aid in publishing on their servers.
It is my thank you to these volanteers / Ctan.

1) License.
ctan_chk's distributed source code is subject to the terms of the GNU General Public License (version 3).
If a copy of the MPL was not distributed with this file, you can obtain one at https://gnu.org/licenses/gpl.html.

2) Ctan_chk reference.
Unzip the ctan_chk.zip file.
Please read ctan_chk.pdf document. It instructs one in ``how to'' use the gawk ctan_chk.gawk program.

3) Literate Programming.
ctan_chk.pdf is generated by Cweb system. Please consider using Cweb and to join
``www.tug.org''.