summaryrefslogtreecommitdiff
path: root/scripts/README
Unidiff
Diffstat (limited to 'scripts/README') (more/less context) (ignore whitespace changes)
-rw-r--r--scripts/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/scripts/README b/scripts/README
new file mode 100644
index 0000000..54295bb
--- a/dev/null
+++ b/scripts/README
@@ -0,0 +1,26 @@
1
2These scripts are for convienence only.
3
4Use them at your own risk.
5
6Especially q_add_variable and q_add_function,
7however when used they should leave behind a backup copy of the
8header file it has tried to modify. Sometimes those two scripts
9find headers that it decides it can't parse and leaves it up to
10the user to edit them manually.
11
12But even still I would highly recommend backing up your files
13or using this in conjuction with some kind of CVS like system.
14
15The script to add a new application is the most useful script
16and creates a very basic QPE app from a template with most of
17the files you need.
18
19Currently these scripts don't integrate with a CVS system and
20add or edit the created/modified files with the repository, you
21have to do that manually, however I have started to make a few
22scripts that are generic repository accessing scripts that
23could be made to work with either p4 or cvs or something else.
24
25John
26