Clean up AppVeyor scripts (#126)
[packages/Win32.git] / README.md
1 The `Win32` Package
2 =====================
3
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)
5
6 See [`Win32` on Hackage](http://hackage.haskell.org/package/Win32) for
7 more information.
8
9 Installing from Git
10 -------------------
11
12 This package requires no special installation instructions.
13
14 To install use `cabal install`
15
16 Documentation
17 -------------------
18 This library is just a direct binding to Windows API calls and
19 as such contains no documentation. The documentation for functions
20 can be found in the equivalently named functions on MSDN 
21 https://msdn.microsoft.com/library/windows/desktop/hh920508.aspx
22
23 Getting Started
24 ---------------
25 The `Win32` library is a core GHC library and as such aims to have an
26 as little as possible footprint when it comes to dependencies.
27
28 When submitting new requests think hard if any new `Haskell` dependencies are
29 actually needed. (note that this does not apply to `C` dependencies.)
30
31 The best way to get started is using `cabal new-build` and `cabal sandboxes`:
32
33 ```
34 git clone git@github.com:haskell/win32.git
35 cd win32
36 cabal sandbox init
37 cabal install
38 cabal repl
39 ```
40
41 Testsuite
42 ---------
43 The tests in the `Win32` package are designed to run as part of the GHC testsuite.
44 As such, should you want to add a new test, you will need the testsuite drivers.
45
46 See https://ghc.haskell.org/trac/ghc/wiki/Building/RunningTests/Adding for details.