README.md 1.57 KB
Newer Older
Tamar Christina's avatar
Tamar Christina committed
1
The `Win32` Package
2
3
=====================

Ryan Scott's avatar
Ryan Scott committed
4
[![Hackage](https://img.shields.io/hackage/v/Win32.svg)](https://hackage.haskell.org/package/Win32) [![PyPI](https://img.shields.io/pypi/l/Django.svg)]() [![Windows build status](https://ci.appveyor.com/api/projects/status/github/haskell/win32?branch=master&svg=true)](https://ci.appveyor.com/project/hvr/win32)
Tamar Christina's avatar
Tamar Christina committed
5

6
7
8
9
10
11
12
13
14
See [`Win32` on Hackage](http://hackage.haskell.org/package/Win32) for
more information.

Installing from Git
-------------------

This package requires no special installation instructions.

To install use `cabal install`
15
16
17
18
19

Documentation
-------------------
This library is just a direct binding to Windows API calls and
as such contains no documentation. The documentation for functions
Tamar Christina's avatar
Tamar Christina committed
20
can be found in the equivalently named functions on MSDN 
21
https://msdn.microsoft.com/library/windows/desktop/hh920508.aspx
22
23
24
25
26
27
28
29
30
31
32
33
34
35

Getting Started
---------------
The `Win32` library is a core GHC library and as such aims to have an
as little as possible footprint when it comes to dependencies.

When submitting new requests think hard if any new `Haskell` dependencies are
actually needed. (note that this does not apply to `C` dependencies.)

The best way to get started is using `cabal new-build` and `cabal sandboxes`:

```
git clone git@github.com:haskell/win32.git
cd win32
Tamar Christina's avatar
Tamar Christina committed
36
cabal v2-repl
37
38
39
40
41
42
43
44
```

Testsuite
---------
The tests in the `Win32` package are designed to run as part of the GHC testsuite.
As such, should you want to add a new test, you will need the testsuite drivers.

See https://ghc.haskell.org/trac/ghc/wiki/Building/RunningTests/Adding for details.