summaryrefslogtreecommitdiff
path: root/vpc_scripts/readme.txt
diff options
context:
space:
mode:
authorFluorescentCIAAfricanAmerican <[email protected]>2020-04-22 12:56:21 -0400
committerFluorescentCIAAfricanAmerican <[email protected]>2020-04-22 12:56:21 -0400
commit3bf9df6b2785fa6d951086978a3e66f49427166a (patch)
tree2c0f1f0c63c4832882bc93814ebd2c2b1c6224e5 /vpc_scripts/readme.txt
downloadarchived-source-engine-2018-hl2-src-master.tar.xz
archived-source-engine-2018-hl2-src-master.zip
Diffstat (limited to 'vpc_scripts/readme.txt')
-rw-r--r--vpc_scripts/readme.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/vpc_scripts/readme.txt b/vpc_scripts/readme.txt
new file mode 100644
index 0000000..c09cbaf
--- /dev/null
+++ b/vpc_scripts/readme.txt
@@ -0,0 +1,33 @@
+Usage for the vpc-generating perl scripts::
+
+(Note, perl is case sensitive.)
+
+
+"generateVPC.pl"
+"generatesimpleVPC.pl"
+
+- Run from the vpc_scripts directory.
+- Use full or relative path to the vcproj file.
+- Use -o to specify an output directory. If no output directory is specified, The vpc script(s) will be generated in the same directory as the source vcproj.
+("generateSimpleVPC.pl" produces a stripped-down version of the output scripts)
+
+Example:
+
+> generateVPC.pl ..\cl_dll\client.vcproj -o ..\cl_dll\tempdir
+
+
+
+"generateSnapshot.pl"
+"generatesimpleSnapshot.pl"
+
+Generates vpc scripts for the entire tree, and places them in a local mirror directory tree named "snapshot". If a snapshot tree already exists, it is renamed to "backup" and a new snapshot is created. This allows running a diff of the two trees to see which vcproj's have changed since the last snapshot.
+
+No arguments are necessary:
+
+> generateSnapshot.pl
+
+
+
+NOTES:
+
+generateVPC.pl always assumes a common base script and optional additional leaf scripts. If a file or property is identical across all project configurations, then it is placed in the base script. If any configuration is different, then that file or property is moved into the appropriate mod's leaf script. This is expected behavior for client and server, but most other projects should only have a base script.