Skip to content

Commit

Permalink
Update documentation for Version.vb
Browse files Browse the repository at this point in the history
  • Loading branch information
Fleex255 committed May 31, 2020
1 parent cbb7dd9 commit c08c3fc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
12 changes: 11 additions & 1 deletion COMPILE.md
@@ -1,5 +1,15 @@
# Compiling Policy Plus
Policy Plus is developed with [Visual Studio 2017 Community](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx). (Fancier Visual Studio editions will work too.)
You can acquire the Policy Plus source code by cloning with [Git](https://git-scm.com/):

git clone https://github.com/Fleex255/PolicyPlus.git

It is recommended to set Git to ignore local changes to the autogenerated version file:

git update-index --assume-unchanged PolicyPlus\Version.vb

You can run `version.bat` at any time to replace that file with one that specifies your current commit.

Policy Plus is developed with [Visual Studio 2019 Community](https://visualstudio.microsoft.com/vs/community/). (Fancier Visual Studio editions will work too.)

To compile, open `PolicyPlus.sln` or `PolicyPlus.vbproj` (from the `PolicyPlus` folder) in Visual Studio. Set the *Solution Configurations* dropdown to Release (or Debug for a debug build).
Choose *Build* | *Build PolicyPlus* from the main menu. The result is `PolicyPlus.exe`, which is set to run on 32-bit or 64-bit environments, preferring to run in a 64-bit process.
Expand Down
1 change: 1 addition & 0 deletions Docs/Components.md
Expand Up @@ -53,4 +53,5 @@ This list shows which code files are responsible for which parts of Policy Plus'
* `Privilege.vb`: Defines the `Privilege` class, which provides a convenience method `EnablePrivilege` that uses the P/Invoke methods in `PInvoke` to enable a privilege given its name.
* `RegFile.vb`: Defines the `RegFile` class, which loads and saves REG files for purposes of import to and export from policy sources. It implements just enough of `IPolicySource` to allow `PolFile.Apply` to work on it, but it cannot be used as an actual policy source.
* `SpolFile.vb`: Defines the `SpolFile` class, which parses a Semantic Policy script into a collection of policy states. These policy states are stored in `SpolPolicyState` instances, the class of which is also defined in this file. Each policy in a SPOL file has a section, a unique ID, a basic state, and optionally element states (if the policy is enabled).
* `Version.vb`: Autogenerated by `version.bat` to provide the last Git tag/commit in the `Version` constant.
* `XmlExtensions.vb`: Defines extension methods on `XmlNode` for convenience when loading XML files in `AdmxFile` and `AdmlFile`.

0 comments on commit c08c3fc

Please sign in to comment.