Add/update READMEs
This commit is contained in:
parent
1d00ae469d
commit
87e452c49f
@ -14,4 +14,5 @@ Set of libraries to deal with filepaths and files.
|
|||||||
|
|
||||||
* [![Hackage version](https://img.shields.io/hackage/v/hpath.svg?label=Hackage)](https://hackage.haskell.org/package/hpath) [hpath](./hpath): Support for well-typed paths
|
* [![Hackage version](https://img.shields.io/hackage/v/hpath.svg?label=Hackage)](https://hackage.haskell.org/package/hpath) [hpath](./hpath): Support for well-typed paths
|
||||||
* [![Hackage version](https://img.shields.io/hackage/v/hpath-filepath.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-filepath) [hpath-filepath](./hpath-filepath): ByteString based filepath manipulation (can be used without hpath)
|
* [![Hackage version](https://img.shields.io/hackage/v/hpath-filepath.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-filepath) [hpath-filepath](./hpath-filepath): ByteString based filepath manipulation (can be used without hpath)
|
||||||
* [![Hackage version](https://img.shields.io/hackage/v/hpath-io.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-io) [hpath-io](./hpath-io): high-level file API (recursive copy, writeFile etc.) using hpath
|
* [![Hackage version](https://img.shields.io/hackage/v/hpath-directory.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-directory) [hpath-directory](./hpath-directory): Hhigh-level IO operations for files/directories on raw ByteString filepaths (use hpath-io for the type-safe path version)
|
||||||
|
* [![Hackage version](https://img.shields.io/hackage/v/hpath-io.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-io) [hpath-io](./hpath-io): High-level IO operations for files/directories utilizing type-safe Path
|
||||||
|
21
hpath-directory/README.md
Normal file
21
hpath-directory/README.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# HPath-filepath
|
||||||
|
|
||||||
|
[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hasufell/hpath?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Hackage version](https://img.shields.io/hackage/v/hpath-directory.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-directory) [![Build Status](https://api.travis-ci.org/hasufell/hpath.png?branch=master)](http://travis-ci.org/hasufell/hpath) [![Hackage-Deps](https://img.shields.io/hackage-deps/v/hpath-directory.svg)](http://packdeps.haskellers.com/feed?needle=hpath-directory)
|
||||||
|
|
||||||
|
Support high-level IO operations on files/directories, utilizing ByteString
|
||||||
|
as FilePaths.
|
||||||
|
|
||||||
|
This package is part of the HPath suite, also check out:
|
||||||
|
|
||||||
|
* [hpath](https://hackage.haskell.org/package/hpath)
|
||||||
|
* [hpath-filepath](https://hackage.haskell.org/package/hpath-filepath)
|
||||||
|
* [hpath-io](https://hackage.haskell.org/package/hpath-io)
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
This is basically a fork of [directory](https://hackage.haskell.org/package/directory), but is a complete rewrite and the API doesn't follow the directory package.
|
||||||
|
|
||||||
|
## Differences to 'posix-paths'
|
||||||
|
|
||||||
|
* has a custom versions of `openFd` which allows more control over the flags than its unix package counterpart
|
||||||
|
* adds a `getDirectoryContents'` version that works on Fd
|
@ -4,7 +4,11 @@
|
|||||||
|
|
||||||
Support for bytestring based filepath manipulation, similar to 'filepath'.
|
Support for bytestring based filepath manipulation, similar to 'filepath'.
|
||||||
|
|
||||||
This package is part of the HPath suite, also check out [hpath](https://hackage.haskell.org/package/hpath) and [hpath-io](https://hackage.haskell.org/package/hpath-io).
|
This package is part of the HPath suite, also check out:
|
||||||
|
|
||||||
|
* [hpath](https://hackage.haskell.org/package/hpath)
|
||||||
|
* [hpath-directory](https://hackage.haskell.org/package/hpath-directory)
|
||||||
|
* [hpath-io](https://hackage.haskell.org/package/hpath-io)
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
|
@ -2,9 +2,13 @@
|
|||||||
|
|
||||||
[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hasufell/hpath?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Hackage version](https://img.shields.io/hackage/v/hpath-io.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-io) [![Build Status](https://api.travis-ci.org/hasufell/hpath.png?branch=master)](http://travis-ci.org/hasufell/hpath) [![Hackage-Deps](https://img.shields.io/hackage-deps/v/hpath-io.svg)](http://packdeps.haskellers.com/feed?needle=hpath-io)
|
[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hasufell/hpath?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Hackage version](https://img.shields.io/hackage/v/hpath-io.svg?label=Hackage)](https://hackage.haskell.org/package/hpath-io) [![Build Status](https://api.travis-ci.org/hasufell/hpath.png?branch=master)](http://travis-ci.org/hasufell/hpath) [![Hackage-Deps](https://img.shields.io/hackage-deps/v/hpath-io.svg)](http://packdeps.haskellers.com/feed?needle=hpath-io)
|
||||||
|
|
||||||
High-level IO operations on files/directories, utilizing type-safe Paths.
|
High-level IO operations on files/directories, utilizing type-safe Paths. This uses [hpath-directory](https://hackage.haskell.org/package/hpath-directory) under the hood.
|
||||||
|
|
||||||
This package is part of the HPath suite, also check out [hpath](https://hackage.haskell.org/package/hpath) and [hpath-filepath](https://hackage.haskell.org/package/hpath-filepath).
|
This package is part of the HPath suite, also check out:
|
||||||
|
|
||||||
|
* [hpath](https://hackage.haskell.org/package/hpath)
|
||||||
|
* [hpath-directory](https://hackage.haskell.org/package/hpath-directory)
|
||||||
|
* [hpath-filepath](https://hackage.haskell.org/package/hpath-filepath)
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
@ -21,8 +25,3 @@ while utilizing type-safe Paths.
|
|||||||
|
|
||||||
Note: this library was written for __posix__ systems and it will probably not support other systems.
|
Note: this library was written for __posix__ systems and it will probably not support other systems.
|
||||||
|
|
||||||
## Differences to 'posix-paths'
|
|
||||||
|
|
||||||
* has a custom versions of `openFd` which allows more control over the flags than its unix package counterpart
|
|
||||||
* adds a `getDirectoryContents'` version that works on Fd
|
|
||||||
|
|
||||||
|
@ -4,7 +4,11 @@
|
|||||||
|
|
||||||
Support for well-typed paths in Haskell.
|
Support for well-typed paths in Haskell.
|
||||||
|
|
||||||
This package is part of the HPath suite, also check out [hpath-filepath](https://hackage.haskell.org/package/hpath-filepath) and [hpath-io](https://hackage.haskell.org/package/hpath-io).
|
This package is part of the HPath suite, also check out:
|
||||||
|
|
||||||
|
* [hpath-directory](https://hackage.haskell.org/package/hpath-directory)
|
||||||
|
* [hpath-filepath](https://hackage.haskell.org/package/hpath-filepath)
|
||||||
|
* [hpath-io](https://hackage.haskell.org/package/hpath-io)
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user