Internal: updated the manual ("Compiling GZDoom Builder" page) and UI to reference GitHub/Git instead of SourceForge/SVN.

Internal: post build event in Builder.csproj worked only when compiling using batch files.
Internal: updated README.md.
This commit is contained in:
MaxED 2016-12-27 13:12:10 +03:00
parent f9c2bbe44a
commit ed3233736b
10 changed files with 113 additions and 33 deletions

View file

@ -23,8 +23,8 @@
<h2>Optional software:</h2>
<ul>
<li>Subversion command-line client. For example, Tortoise SVN (<a href="http://tortoisesvn.net/">http://tortoisesvn.net</a>).<br />
<strong>Notice</strong>: when installing Tortoise SVN, make sure to select &quot;command line client tools&quot; option.</li>
<li>Git command-line client (<a href="https://git-scm.com/">https://git-scm.com/</a>).</li>
<li>TortoiseGit (<a href="https://tortoisegit.org/">https://tortoisegit.org/</a>).</li>
<li>7-zip archiver (<a href="www.7-zip.org">www.7-zip.org</a>).</li>
<li>Inno Setup 5 or newer (<a href="http://www.jrsoftware.org/isinfo.php">http://www.jrsoftware.org/isinfo.php</a>).</li>
<li>Microsoft HTML Help compiler (<a href="http://www.microsoft.com/en-us/download/details.aspx?id=21138">http://www.microsoft.com/en-us/download/details.aspx?id=21138</a>).</li>
@ -33,29 +33,29 @@
</ul>
<h2>Obtaining the source:</h2>
The GZDoom Builder source code is hosted on SourceForge and is available through SVN at the following location:
<pre>https://svn.code.sf.net/p/doombuilder/code/branches/GZDoomBuilder</pre>
If you don't want to use a SVN client, head to <a href="https://sourceforge.net/p/doombuilder/code/HEAD/tree/branches/GZDoomBuilder/">https://sourceforge.net/p/doombuilder/code/HEAD/tree/branches/GZDoomBuilder/</a> and press &quot;Download Snapshot&quot; button.
The GZDoom Builder source code is hosted at GitHub (<a href="https://github.com/m-x-d/GZDoom-Builder">https://github.com/m-x-d/GZDoom-Builder</a>).
<h2>Quick start guide:</h2>
This guide assumes you are using <strong>Visual Studio 2008</strong> / <strong>Visual C# 2008 Express Edition</strong> and <strong>Tortiose SVN</strong>.
This guide assumes you are using <strong>Visual Studio 2008</strong> / <strong>Visual C# 2008 Express Edition</strong> and <strong>TortioseGit</strong>.
<ol>
<li>Create an empty folder, right click on it and choose "<strong>SVN Checkout...</strong>" from the context menu.</li>
<li>Enter &quot;<strong>https://svn.code.sf.net/p/doombuilder/code/branches/GZDoomBuilder</strong>&quot; in the &quot;<strong>URL of repository</strong>&quot; field and click OK.</li>
<li>Create an empty folder, right click on it and choose "<strong>GIT Clone...</strong>" from the context menu.</li>
<li>Enter &quot;<strong>https://github.com/m-x-d/GZDoom-Builder.git</strong>&quot; in the &quot;<strong>URL</strong>&quot; field, click OK and wait for the source to download.</li>
<li> Open &quot;<strong>Builder.sln</strong>&quot; in the Visual Studio and make sure it compiles and runs (click the green &quot;<strong>Play</strong>&quot; button, or press <strong>F5</strong>).
<ul>
<li>If the Visual Studio complains about missing <strong>SlimDX</strong> reference in the Builder project, you'll need to re-add it manually. To do so, delete SlimDX from the References in the Solution Explorer, right click on the Builder project and choose &quot;<strong>Add reference</strong>&quot;. On the .NET tab, choose SlimDX (.net 2.0, x86 version).</li>
<li>You can ignore the warning about missing <strong>JetBrains.Profiler.Core.Api</strong> reference. Everything should build fine, unless you choose a profiler-enabled build target (or you can use dotTrace Performance, if you have access to it).</li>
</ul>
</li>
<li>If you've made some code changes and want to submit them to the main GZDB repository, you can make a diff patch (right-click on the GZDB source folder and choose &quot;<strong>TortioseSVN -&gt; Create patch...</strong>&quot;) and post it at the official GZDB thread at ZDoom.org (<a href="http://forum.zdoom.org/viewtopic.php?f=3&t=32392&start=999999">http://forum.zdoom.org/viewtopic.php?f=3&amp;t=32392&amp;start=999999</a>).</li>
<li>If you are planning to submit your changes to the main GZDoom Builder repository, it's recomeded to fork GZDoom Builder at GitHub, make the changes, then submit a Pull Request.</li>
</ol>
<h2>Batch files:</h2>
GZDB source comes with several batch files, which can be used to automatically compile and package the editor. Before launching a batch file for the first time, make sure to open it and check that variables holding software paths point to the right directories. These variables are always located near the top of the file, after the info block.
<ul>
<li><strong>Clean Rebuild.bat</strong> - removes project cache files, then compiles it in Release mode.<br />Requires Visual C# Express Edition / Visual Studio.</li><br />
<li><strong>CompileHelp.bat</strong> - compiles &quot;Build\Refmanual.chm&quot;. Help source files are located in the &quot;Help&quot; directory.<br />Requires Microsoft HTML Help compiler.</li><br />
<li><strong>MakeRelease.bat</strong> - removes project cache files, sets project version number to match the latest SVN revision, compiles the project in Release mode, generates &quot;Build\Changelog.txt&quot;, compiles &quot;Build\Refmanual.chm&quot;, creates an installer and places it in the &quot;Release&quot; folder.<br />Requires Subversion command-line client, Visual C# Express Edition / Visual Studio, Microsoft HTML Help compiler and Inno Setup 5.</li><br />
<li><strong>MakeSVNRelease.bat</strong> - removes project cache files, sets project version number to match the latest SVN revision, compiles the project in Release mode, generates &quot;Build\Changelog.txt&quot;, compiles &quot;Build\Refmanual.chm&quot;, packs the build into 7-zip archive and places it in the &quot;SVN_Build&quot; folder.<br />Requires Subversion command-line client, Visual C# Express Edition / Visual Studio, Microsoft HTML Help compiler and 7-zip archiver.</li>
<li><strong>MakeRelease.bat</strong> - removes project cache files, sets project version number to match the latest SVN revision, compiles the project in Release mode, generates &quot;Build\Changelog.txt&quot;, compiles &quot;Build\Refmanual.chm&quot;, creates an installer and places it in the &quot;Release&quot; folder.<br />
Requires Git command-line client, Visual C# Express Edition / Visual Studio, Microsoft HTML Help compiler and Inno Setup 5.</li><br />
<li><strong>MakeGITRelease.bat</strong> - removes project cache files, sets project version number to match the number of commits in the master branch, compiles the project in Release mode, generates &quot;Build\Changelog.txt&quot;, compiles &quot;Build\Refmanual.chm&quot;, packs the build into 7-zip archive and places it in the &quot;GIT_Build&quot; folder.<br />
Requires Git command-line client, Visual C# Express Edition / Visual Studio, Microsoft HTML Help compiler and 7-zip archiver.</li>
</ul>
</div>
</body>

View file

@ -1,4 +1,20 @@
Comprehensive map editor for Doom, Heretic, Hexen and Strife based games mainly geared towards GZDoom source port.
Includes 3D editing mode and various other modern tools and techniques such as script editors with syntax highlighting and auto-complete.
System requirements:
• 2.4 GHz CPU or faster (multi-core recommended).
• Windows XP, Vista, 7, 8 or 10.
• Graphics card with Pixel Shader model 2.0 support.
Required software:
• Microsoft .Net Framework 3.5 (http://www.microsoft.com/download/en/details.aspx?id=25150).
• DirectX 9.0 Runtime (https://www.microsoft.com/en-us/download/details.aspx?id=35&44F86079-8679-400C-BFF2-9CA5F2BCBDFC=1).
Official thread at ZDoom.org:
• http://forum.zdoom.org/viewtopic.php?f=3&t=32392
Unofficial thread at iddqd.ru (in russian):
• http://i.iddqd.ru/viewtopic.php?t=522
Git builds at DRDTeam.org:
• http://devbuilds.drdteam.org/doombuilder2-gzdb/
More detailed info can be found in the editor documentation (Refmanual.chm).
Based on Doom Builder 2 by CodeImp (http://www.doombuilder.com/).

View file

@ -1215,6 +1215,7 @@
<None Include="Resources\ErrorLargeText.png" />
<EmbeddedResource Include="Resources\Folder96.png" />
<EmbeddedResource Include="Resources\Folder96Up.png" />
<None Include="Resources\Github.png" />
<Content Include="Resources\Light.png" />
<None Include="Resources\Lightbulb.png" />
<None Include="Resources\LightDisabled.png" />
@ -1440,7 +1441,12 @@
<PropertyGroup>
<PreBuildEvent>
</PreBuildEvent>
<PostBuildEvent>call "%25VSINSTALLDIR%25\Common7\Tools\vsvars32.bat"
EDITBIN.EXE /NOLOGO /LARGEADDRESSAWARE "$(TargetPath)"</PostBuildEvent>
<PostBuildEvent>if exist "%25VS140COMNTOOLS%25" call "%25VS140COMNTOOLS%25vsvars32.bat"
else if exist "%25VS120COMNTOOLS%25" call "%25VS120COMNTOOLS%25vsvars32.bat"
else if exist "%25VS110COMNTOOLS%25" call "%25VS110COMNTOOLS%25vsvars32.bat"
else if exist "%25VS100COMNTOOLS%25" call "%25VS100COMNTOOLS%25vsvars32.bat"
else if exist "%25VS90COMNTOOLS%25" call "%25VS90COMNTOOLS%25vsvars32.bat"
editbin.exe /NOLOGO /LARGEADDRESSAWARE "$(TargetPath)"</PostBuildEvent>
</PropertyGroup>
</Project>

View file

@ -375,6 +375,13 @@ namespace CodeImp.DoomBuilder.Properties {
}
}
internal static System.Drawing.Bitmap Github {
get {
object obj = ResourceManager.GetObject("Github", resourceCulture);
return ((System.Drawing.Bitmap)(obj));
}
}
internal static System.Drawing.Bitmap Grid2 {
get {
object obj = ResourceManager.GetObject("Grid2", resourceCulture);

View file

@ -613,4 +613,7 @@
<data name="Folder96Up" type="System.Resources.ResXFileRef, System.Windows.Forms">
<value>..\Resources\Folder96Up.png;System.Drawing.Bitmap, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
</data>
<data name="Github" type="System.Resources.ResXFileRef, System.Windows.Forms">
<value>..\Resources\Github.png;System.Drawing.Bitmap, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
</data>
</root>

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

View file

@ -37,8 +37,10 @@ namespace CodeImp.DoomBuilder.Windows
this.codeimplink = new System.Windows.Forms.LinkLabel();
this.tabControl1 = new System.Windows.Forms.TabControl();
this.tabPage1 = new System.Windows.Forms.TabPage();
this.gitlink = new System.Windows.Forms.LinkLabel();
this.label2 = new System.Windows.Forms.Label();
this.pictureBox4 = new System.Windows.Forms.PictureBox();
this.gzdbLink = new System.Windows.Forms.LinkLabel();
this.zdoomorglink = new System.Windows.Forms.LinkLabel();
this.copyversion = new System.Windows.Forms.Button();
this.version = new System.Windows.Forms.Label();
this.tabPage2 = new System.Windows.Forms.TabPage();
@ -146,9 +148,11 @@ namespace CodeImp.DoomBuilder.Windows
//
// tabPage1
//
this.tabPage1.Controls.Add(this.gitlink);
this.tabPage1.Controls.Add(this.label2);
this.tabPage1.Controls.Add(pictureBox3);
this.tabPage1.Controls.Add(this.pictureBox4);
this.tabPage1.Controls.Add(this.gzdbLink);
this.tabPage1.Controls.Add(this.zdoomorglink);
this.tabPage1.Controls.Add(this.copyversion);
this.tabPage1.Controls.Add(this.version);
this.tabPage1.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(204)));
@ -160,6 +164,28 @@ namespace CodeImp.DoomBuilder.Windows
this.tabPage1.Text = "About GZDoom Builder";
this.tabPage1.UseVisualStyleBackColor = true;
//
// gitlink
//
this.gitlink.AutoSize = true;
this.gitlink.LinkColor = System.Drawing.SystemColors.HotTrack;
this.gitlink.Location = new System.Drawing.Point(169, 181);
this.gitlink.Name = "gitlink";
this.gitlink.Size = new System.Drawing.Size(134, 13);
this.gitlink.TabIndex = 18;
this.gitlink.TabStop = true;
this.gitlink.Text = "Project page at github.com";
this.gitlink.LinkClicked += new System.Windows.Forms.LinkLabelLinkClickedEventHandler(this.gitlink_LinkClicked);
//
// label2
//
this.label2.AutoSize = true;
this.label2.Location = new System.Drawing.Point(14, 135);
this.label2.Name = "label2";
this.label2.Size = new System.Drawing.Size(286, 26);
this.label2.TabIndex = 17;
this.label2.Text = "GZDoom Builder is designed and programmed by MaxED.\r\nGZDoom Builder uses game con" +
"figurations created by Gez.";
//
// pictureBox4
//
this.pictureBox4.Image = global::CodeImp.DoomBuilder.Properties.Resources.MLogo;
@ -170,20 +196,17 @@ namespace CodeImp.DoomBuilder.Windows
this.pictureBox4.TabIndex = 16;
this.pictureBox4.TabStop = false;
//
// gzdbLink
// zdoomorglink
//
this.gzdbLink.AutoSize = true;
this.gzdbLink.LinkArea = new System.Windows.Forms.LinkArea(110, 152);
this.gzdbLink.LinkColor = System.Drawing.SystemColors.HotTrack;
this.gzdbLink.Location = new System.Drawing.Point(11, 136);
this.gzdbLink.Name = "gzdbLink";
this.gzdbLink.Size = new System.Drawing.Size(309, 42);
this.gzdbLink.TabIndex = 15;
this.gzdbLink.TabStop = true;
this.gzdbLink.Text = "GZDoom Builder is designed and programmed by MaxED.\r\nGZDoom Builder uses game con" +
"figurations created by Gez.\r\nOfficial thread at ZDoom.org";
this.gzdbLink.UseCompatibleTextRendering = true;
this.gzdbLink.LinkClicked += new System.Windows.Forms.LinkLabelLinkClickedEventHandler(this.gzdbLink_LinkClicked);
this.zdoomorglink.AutoSize = true;
this.zdoomorglink.LinkColor = System.Drawing.SystemColors.HotTrack;
this.zdoomorglink.Location = new System.Drawing.Point(14, 181);
this.zdoomorglink.Name = "zdoomorglink";
this.zdoomorglink.Size = new System.Drawing.Size(140, 13);
this.zdoomorglink.TabIndex = 15;
this.zdoomorglink.TabStop = true;
this.zdoomorglink.Text = "Official thread at ZDoom.org";
this.zdoomorglink.LinkClicked += new System.Windows.Forms.LinkLabelLinkClickedEventHandler(this.zdoomorglink_LinkClicked);
//
// copyversion
//
@ -261,9 +284,11 @@ namespace CodeImp.DoomBuilder.Windows
private System.Windows.Forms.TabControl tabControl1;
private System.Windows.Forms.TabPage tabPage1;
private System.Windows.Forms.PictureBox pictureBox4;
private System.Windows.Forms.LinkLabel gzdbLink;
private System.Windows.Forms.LinkLabel zdoomorglink;
private System.Windows.Forms.Button copyversion;
private System.Windows.Forms.Label version;
private System.Windows.Forms.TabPage tabPage2;
private System.Windows.Forms.Label label2;
private System.Windows.Forms.LinkLabel gitlink;
}
}

View file

@ -53,11 +53,17 @@ namespace CodeImp.DoomBuilder.Windows
}
//mxd
private void gzdbLink_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
private void zdoomorglink_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
{
General.OpenWebsite("http://forum.zdoom.org/viewtopic.php?f=3&t=32392");
}
//mxd
private void gitlink_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
{
General.OpenWebsite("https://github.com/m-x-d/GZDoom-Builder");
}
// This copies the version number to clipboard
private void copyversion_Click(object sender, EventArgs e)
{

View file

@ -147,6 +147,7 @@ namespace CodeImp.DoomBuilder.Windows
this.itemhelpeditmode = new System.Windows.Forms.ToolStripMenuItem();
this.itemhelpcheckupdates = new System.Windows.Forms.ToolStripMenuItem();
this.seperatorhelpmanual = new System.Windows.Forms.ToolStripSeparator();
this.itemhelpissues = new System.Windows.Forms.ToolStripMenuItem();
this.itemhelpabout = new System.Windows.Forms.ToolStripMenuItem();
this.toolbar = new System.Windows.Forms.ToolStrip();
this.toolbarContextMenu = new System.Windows.Forms.ContextMenuStrip(this.components);
@ -1231,6 +1232,7 @@ namespace CodeImp.DoomBuilder.Windows
this.itemShortcutReference,
this.itemopenconfigfolder,
this.itemhelpeditmode,
this.itemhelpissues,
this.itemhelpcheckupdates,
this.seperatorhelpmanual,
this.itemhelpabout});
@ -1286,6 +1288,14 @@ namespace CodeImp.DoomBuilder.Windows
this.seperatorhelpmanual.Name = "seperatorhelpmanual";
this.seperatorhelpmanual.Size = new System.Drawing.Size(229, 6);
//
// itemhelpissues
//
this.itemhelpissues.Image = global::CodeImp.DoomBuilder.Properties.Resources.Github;
this.itemhelpissues.Name = "itemhelpissues";
this.itemhelpissues.Size = new System.Drawing.Size(232, 22);
this.itemhelpissues.Text = "&GitHub issues tracker";
this.itemhelpissues.Click += new System.EventHandler(this.itemhelpissues_Click);
//
// itemhelpabout
//
this.itemhelpabout.Image = global::CodeImp.DoomBuilder.Properties.Resources.About;
@ -2799,6 +2809,7 @@ namespace CodeImp.DoomBuilder.Windows
private System.Windows.Forms.ToolStripMenuItem itemclosemap;
private System.Windows.Forms.Timer redrawtimer;
private System.Windows.Forms.ToolStripMenuItem menuhelp;
private System.Windows.Forms.ToolStripMenuItem itemhelpissues;
private System.Windows.Forms.ToolStripMenuItem itemhelpabout;
private System.Windows.Forms.ToolStripMenuItem itemhelpcheckupdates;
private CodeImp.DoomBuilder.Controls.RenderTargetControl display;

View file

@ -3091,6 +3091,12 @@ namespace CodeImp.DoomBuilder.Windows
{
UpdateChecker.PerformCheck(true);
}
//mxd. Github issues clicked
private void itemhelpissues_Click(object sender, EventArgs e)
{
General.OpenWebsite("https://github.com/m-x-d/GZDoom-Builder/issues");
}
// About clicked
private void itemhelpabout_Click(object sender, EventArgs e)