mirror of
https://github.com/chibicitiberiu/rainmeter-studio.git
synced 2024-02-24 04:33:31 +00:00
Fixed line endings and applied gitignore
This commit is contained in:
@ -1,39 +1,39 @@
|
||||
## Building Rainmeter
|
||||
|
||||
### Get the source code
|
||||
|
||||
Use <a href="http://git-scm.com">Git</a> to clone the repository:
|
||||
|
||||
git clone https://github.com/rainmeter/rainmeter.git
|
||||
|
||||
Alternatively, download the repository contents as a [ZIP archive](https://github.com/rainmeter/rainmeter/archive/master.zip).
|
||||
|
||||
|
||||
### Building with Visual Studio
|
||||
|
||||
Rainmeter can be built using any version of Visual Studio 2013. If you don't already have VS2013, you can download the free "Visual Studio Express 2013 for Windows Desktop" version [here](http://www.visualstudio.com/downloads/download-visual-studio-vs).
|
||||
|
||||
After Visual Studio has been installed and updated, open Rainmeter.sln at the root of the repository to build.
|
||||
|
||||
|
||||
### Building the installer
|
||||
|
||||
First, download and install <a href="https://code.google.com/p/unsis/downloads/list">NSIS Unicode</a> (download the Unicode version, not the ANSI version).
|
||||
|
||||
Now you can simply run the <b>Build.bat</b> batch file in the Build folder of your local repository. If you see any "not found" errors, check that the paths in the `set` commands at the top of the file match your environment. To build the release (non-beta) installer, use `Build.bat RELEASE`.
|
||||
|
||||
To digitally sign the installer and the Rainmeter executables, obtain a Windows code signing certificate and create a Certificate.bat file alongside Build.bat with the following contents:
|
||||
|
||||
set CERTFILE=/path/to/PFXcert.p12
|
||||
set CERTKEY=certpassword
|
||||
|
||||
|
||||
### Building old versions
|
||||
|
||||
The Rainmeter GitHub repository does not contain the full source code history required to build the installer for versions prior to r1249. To obtain the full source from r1 to r1248, use the old Google Code SVN repository located at:
|
||||
|
||||
http://rainmeter.googlecode.com/svn
|
||||
|
||||
The build instructions above are applicable to r1130 - r1248. Build instructions for r27 - r1129 can be found in svn/wiki/.
|
||||
|
||||
## Building Rainmeter
|
||||
|
||||
### Get the source code
|
||||
|
||||
Use <a href="http://git-scm.com">Git</a> to clone the repository:
|
||||
|
||||
git clone https://github.com/rainmeter/rainmeter.git
|
||||
|
||||
Alternatively, download the repository contents as a [ZIP archive](https://github.com/rainmeter/rainmeter/archive/master.zip).
|
||||
|
||||
|
||||
### Building with Visual Studio
|
||||
|
||||
Rainmeter can be built using any version of Visual Studio 2013. If you don't already have VS2013, you can download the free "Visual Studio Express 2013 for Windows Desktop" version [here](http://www.visualstudio.com/downloads/download-visual-studio-vs).
|
||||
|
||||
After Visual Studio has been installed and updated, open Rainmeter.sln at the root of the repository to build.
|
||||
|
||||
|
||||
### Building the installer
|
||||
|
||||
First, download and install <a href="https://code.google.com/p/unsis/downloads/list">NSIS Unicode</a> (download the Unicode version, not the ANSI version).
|
||||
|
||||
Now you can simply run the <b>Build.bat</b> batch file in the Build folder of your local repository. If you see any "not found" errors, check that the paths in the `set` commands at the top of the file match your environment. To build the release (non-beta) installer, use `Build.bat RELEASE`.
|
||||
|
||||
To digitally sign the installer and the Rainmeter executables, obtain a Windows code signing certificate and create a Certificate.bat file alongside Build.bat with the following contents:
|
||||
|
||||
set CERTFILE=/path/to/PFXcert.p12
|
||||
set CERTKEY=certpassword
|
||||
|
||||
|
||||
### Building old versions
|
||||
|
||||
The Rainmeter GitHub repository does not contain the full source code history required to build the installer for versions prior to r1249. To obtain the full source from r1 to r1248, use the old Google Code SVN repository located at:
|
||||
|
||||
http://rainmeter.googlecode.com/svn
|
||||
|
||||
The build instructions above are applicable to r1130 - r1248. Build instructions for r27 - r1129 can be found in svn/wiki/.
|
||||
|
||||
The language files for r963 - r1214 were in a separate repository (svn:externals), which is not available any longer. As a result, the language .dll's for those revisions cannot be built.
|
||||
@ -1,32 +1,32 @@
|
||||
Rainmeter uses the [Visual Studio Native Unit Testing framework](http://msdn.microsoft.com/en-us/library/hh598953.aspx) for unit testing.
|
||||
|
||||
|
||||
### General notes
|
||||
|
||||
All unit test files should have the `<ExcludedFromBuild>$(ExcludeTests)</ExcludedFromBuild>` property set. The easiest way to ensure this is to manually edit the `ClCompile` entry of the project .vcxproj file. Make sure it looks something like this:
|
||||
|
||||
<ClCompile Include="ConfigParser_Test.cpp">
|
||||
<ExcludedFromBuild>$(ExcludeTests)</ExcludedFromBuild>
|
||||
</ClCompile>
|
||||
|
||||
When building within Visual Studio, the macro `$(ExcludeTests)` evaluates to `false` (i.e. the test files are **not** excluded). When building using Build.bat, it evaluates to `true`, and, consequently, the test files are excluded from the build. This is done in order to both reduce the actual build size and remove any kind of dependency on *Microsoft.VisualStudio.TestTools.CppUnitTestFramework.dll* (see below).
|
||||
|
||||
|
||||
### Project type specific notes
|
||||
|
||||
* Static library projects:
|
||||
|
||||
Unit testing static library project requires the use of a separate DLL project. The static library project contains the actual code while the DLL project references the static library and includes the testing code.
|
||||
|
||||
See `Common\Common.vcxproj` and `Common\Common_Test.vcxproj` for an example.
|
||||
|
||||
* Dynamic library projects:
|
||||
|
||||
A unit tested dynamic library project should contain both the actual code and the testing code.
|
||||
|
||||
In addition, the `$(DelayLoadTestDLL)` macro should be included in the linker *Delay Loaded Dlls* option. The VS unit testing framework introduces a dependency on *Microsoft.VisualStudio.TestTools.CppUnitTestFramework.dll* for dynamic library projects, which means that omitting the `$(DelayLoadTestDLL)` macro will result in the dynamic library failing to load.
|
||||
|
||||
|
||||
### Running tests
|
||||
|
||||
When you build the test project, the tests appear in **Test Explorer**. If Test Explorer is not visible, choose **Test** on the Visual Studio menu, choose **Windows**, and then choose **Test Explorer**. From there, you can run all or a subset of the tests.
|
||||
Rainmeter uses the [Visual Studio Native Unit Testing framework](http://msdn.microsoft.com/en-us/library/hh598953.aspx) for unit testing.
|
||||
|
||||
|
||||
### General notes
|
||||
|
||||
All unit test files should have the `<ExcludedFromBuild>$(ExcludeTests)</ExcludedFromBuild>` property set. The easiest way to ensure this is to manually edit the `ClCompile` entry of the project .vcxproj file. Make sure it looks something like this:
|
||||
|
||||
<ClCompile Include="ConfigParser_Test.cpp">
|
||||
<ExcludedFromBuild>$(ExcludeTests)</ExcludedFromBuild>
|
||||
</ClCompile>
|
||||
|
||||
When building within Visual Studio, the macro `$(ExcludeTests)` evaluates to `false` (i.e. the test files are **not** excluded). When building using Build.bat, it evaluates to `true`, and, consequently, the test files are excluded from the build. This is done in order to both reduce the actual build size and remove any kind of dependency on *Microsoft.VisualStudio.TestTools.CppUnitTestFramework.dll* (see below).
|
||||
|
||||
|
||||
### Project type specific notes
|
||||
|
||||
* Static library projects:
|
||||
|
||||
Unit testing static library project requires the use of a separate DLL project. The static library project contains the actual code while the DLL project references the static library and includes the testing code.
|
||||
|
||||
See `Common\Common.vcxproj` and `Common\Common_Test.vcxproj` for an example.
|
||||
|
||||
* Dynamic library projects:
|
||||
|
||||
A unit tested dynamic library project should contain both the actual code and the testing code.
|
||||
|
||||
In addition, the `$(DelayLoadTestDLL)` macro should be included in the linker *Delay Loaded Dlls* option. The VS unit testing framework introduces a dependency on *Microsoft.VisualStudio.TestTools.CppUnitTestFramework.dll* for dynamic library projects, which means that omitting the `$(DelayLoadTestDLL)` macro will result in the dynamic library failing to load.
|
||||
|
||||
|
||||
### Running tests
|
||||
|
||||
When you build the test project, the tests appear in **Test Explorer**. If Test Explorer is not visible, choose **Test** on the Visual Studio menu, choose **Windows**, and then choose **Test Explorer**. From there, you can run all or a subset of the tests.
|
||||
|
||||
Reference in New Issue
Block a user