diff options
author | w0rp <devw0rp@gmail.com> | 2016-10-07 21:33:16 +0100 |
---|---|---|
committer | w0rp <devw0rp@gmail.com> | 2016-10-07 21:33:16 +0100 |
commit | 4489514e4b3edb4376040ed217c95b5ccb489bb0 (patch) | |
tree | 3b379280548e209414e46ae43dc45329d798d8c9 /CONTRIBUTING.md | |
parent | 2f86a92ecbd276b694d0a33db954e7e148b733a8 (diff) | |
download | ale-4489514e4b3edb4376040ed217c95b5ccb489bb0.zip |
Add a wrapper program for running linters which cannot receive stdin input on Windows.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9aa11446..e263d37f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,7 @@ 1. [Guidelines](#guidelines) 2. [Creating Pull Requests](#pull-requests) +3. [Creating Pull Requests](#compiling) <a name="guidelines"></a> @@ -40,6 +41,21 @@ table and list. # 2.2. Adding New Options If you add new options to the plugin, make sure to document those new options in the [README.md](README.md) file, and also -in the [help file](doc/ale.txt). Follow the format of other options in each. Global options should appear in the README +in the [help file](doc/ale.txt). Follow the format of other options in each. Global options should appear in the README file, and in the relevant section in the help file, and options specific to a particular linter should go in the section for that linter. + +<a name="compiling"></a> + +# 3. Compiling the Windows stdin wrapper + +To compile the stdin wrapper program for Windows, when updating the D program, you will need to compile the program with +[LDC](https://github.com/ldc-developers/ldc) in release mode. Download and install the Community edition of Visual Studio +from [the Visual Studio website](https://www.visualstudio.com/downloads/) first before installing LDC. LDC typically comes in +a ZIP you can just extract somewhere. + +Make sure to compile with the 32-bit architecture flag, otherwise the EXE will not run on 32-bit machines. + +``` +ldc2 -m32 -Oz -release stdin_wrapper.d -of=stdin-wrapper.exe +``` |