README.md

winres

A simple library to facilitate adding metainformation and icons to windows executables and dynamic libraries.

Documentation

Toolkit

Before we begin you need to have the approptiate tools installed.

• rc.exe from the Windows SDK
• windres.exe and ar.exe from minGW64

If you are using Rust with the MSVC ABI you will need the Windows SDK for the GNU ABI you'll need minGW64.

Windows SDK can be found in the registry, minGW64 has to be in the path.

Using winres

First, you will need to add a build script to your crate (build.rs) by adding it to your crate's Cargo.toml file:

[package]
#...
build = "build.rs"

[build-dependencies]
winres = "0.1"

Next, you have to write a build script. A short example is shown below.

// build.rs

extern crate winres;

fn main() {
  if cfg!(target_os = "windows") {
    let mut res = winres::WindowsResource::new();
    res.set_icon("test.ico");
    res.compile().unwrap();
  }
}

Thats it. The file test.ico should be located in the same directory as build.rs. Metainformation (like program version and description) is taken from Cargo.toml's [package] section.

Note that using this crate on non windows platform is undefined behavior. It does not contain safeguards against doing so. None-the-less it will compile; however build.rs, as shown above, should contain a cfg option.

Another possibility is using cfg as a directive to avoid building winres on unix platforms alltogether. This will save build time. So the example from before could look like this

[package]
#...
build = "build.rs"

[target.'cfg(windows)'.build-dependencies]
winres = "0.1"

Next, you have to write a build script. A short example is shown below.

// build.rs

#[cfg(windows)]
extern crate winres;

#[cfg(windows)]
fn main() {
    let mut res = winres::WindowsResource::new();
    res.set_icon("test.ico");
    res.compile().unwrap();
}

#[cfg(unix)]
fn main() {
}

Additional Options

For added convenience, winres parses, Cargo.toml for a package.metadata.winres section:

[package.metadata.winres]
OriginalFilename = "PROGRAM.EXE"
LegalCopyright = "Copyright © 2016"
#...

This section may contain arbitrary string key-value pairs, to be included in the version info section of the executable/library file.

The following keys have special meanings and will be shown in the file properties of the Windows Explorer:

FileDescription, ProductName, ProductVersion, OriginalFilename and LegalCopyright

See MSDN for more details on the version info section of executables/libraries.

About this project

I've written this crate chiefly for my personal projects and although I've tested it on my personal computers I have no idea if the behaviour is the same everywhere.

To be brief, I'm very much reliant on your bug reports and feature suggestions to make this crate better.