README.md
The `Win32` Package
=====================
[![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/b8dfn205r791rxw5/branch/master?svg=true)](https://ci.appveyor.com/project/Mistuke/win32-5ec4k/branch/master)
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`
Documentation
-------------------
This library is just a direct binding to Windows API calls and
as such contains no documentation. The documentation for functions
can be found in the equivalently named functions on MSDN
https://msdn.microsoft.com/library/windows/desktop/hh920508.aspx
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
cabal v2-repl
```