Markdownify `README.md` and remove obsolete `.bat`s
authorHerbert Valerio Riedel <hvr@gnu.org>
Fri, 18 Oct 2013 12:50:03 +0000 (14:50 +0200)
committerHerbert Valerio Riedel <hvr@gnu.org>
Fri, 18 Oct 2013 12:52:18 +0000 (14:52 +0200)
The old dead links in readme.txt have been updated/removed, and some
typos fixed. README.md has been added to source tarball via
`extra-source-files`.

Signed-off-by: Herbert Valerio Riedel <hvr@gnu.org>
README.md [new file with mode: 0644]
filepath.cabal
make-docs.bat [deleted file]
push.bat [deleted file]
readme.txt [deleted file]
tests/test.bat [deleted file]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..77eba7b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+System.FilePath  [![Build Status](https://travis-ci.org/ghc/packages-filepath.png?branch=master)](https://travis-ci.org/ghc/packages-filepath)
+===============
+
+I have written a `System.FilePath` module in part based on the one in
+Yhc, and in part based on the one in Cabal (thanks to Lemmih). The aim
+is to try and get this module into the base package, as `FilePath`s
+are something many programs use, but its all too easy to hack up a
+little function that gets it right most of the time on most platforms,
+and there lies a source of bugs.
+
+This module is Posix (Linux) and Windows capable - just import
+`System.FilePath` and it will pick the right one. Of course, if you
+demand Windows paths on all OSes, then `System.FilePath.Windows` will
+give you that (same with Posix). Written in Haskell 98 with
+Hierarchical Modules.
+
+If you go to the 
+[Haddock](http://hackage.haskell.org/package/filepath/docs/System-FilePath.html)
+page, there are a few little examples at the top of the re-exported module.
+
+
+Acknowledgments
+---------------
+
+Thanks to Marc Webber, shapr, David House, Lemmih, others...
+
+
+Competitors
+-----------
+
+`System.FilePath` from Cabal, by Lemmih `FilePath.hs` and
+`NameManip.hs` from MissingH
+
+The one from Cabal and `FilePath.hs` in MissingH are both very
+similar, I stole lots of good ideas from those two.
+
+`NameManip.hs` seems to be more unix specific, but all functions in
+that module have equivalents in this new `System.FilePath` module.
+
+Hopefully this new module can be used without noticing any lost
+functions, and certainly adds new features/functions to the table.
+
+
+Should `FilePath` be an abstract data type?
+-------------------------------------------
+
+The answer for this library is no. This is a deliberate design decision.
+
+In Haskell 98 the definition is `type FilePath = String`, and all
+functions operating on `FilePath`s, i.e. `readFile`/`writeFile` etc
+take `FilePath`s. The only way to introduce an abstract type is to
+provide wrappers for these functions or casts between `String`s and
+`FilePathAbstract`s.
+
+There are also additional questions as to what constitutes a
+`FilePath`, and what is just a pure `String`. For example,
+"/path/file.ext" is a `FilePath`. Is "/" ? "/path" ? "path" ?
+"file.ext" ? ".ext" ? "file" ?
+
+With that being accepted, it should be trivial to write
+`System.FilePath.ByteString` which has the same interface as
+`System.FilePath` yet operates on `ByteString`s.
index 23955f5..570263d 100644 (file)
@@ -15,6 +15,7 @@ tested-with:    GHC==7.6.3, GHC==7.6.2, GHC==7.6.1, GHC==7.4.2, GHC==7.4.1, GHC=
 
 Extra-Source-Files:
     System/FilePath/Internal.hs
+    README.md
 
 Library
     default-language: Haskell98
diff --git a/make-docs.bat b/make-docs.bat
deleted file mode 100644 (file)
index 3af98e1..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-mkdir docs\r
-cpphs --noline System\FilePath.hs         -D__HADDOCK__ > docs\System.FilePath.hs\r
-cpphs --noline System\FilePath\Windows.hs -D__HADDOCK__ > docs\System.FilePath.Windows.hs\r
-cpphs --noline System\FilePath\Posix.hs   -D__HADDOCK__ > docs\System.FilePath.Posix.hs\r
-\r
-haddock -h docs\System.FilePath.hs docs\System.FilePath.Posix.hs docs\System.FilePath.Windows.hs --odir=docs --source-module=%%{MODULE}.html --source-entity=%%{MODULE}.html#%%{NAME}\r
-\r
-copy d:\bin\hscolour.css docs\hscolour.css\r
-hscolour -anchor -css docs\System.FilePath.hs         > docs\System.FilePath.html\r
-hscolour -anchor -css docs\System.FilePath.Windows.hs > docs\System.FilePath.Windows.html\r
-hscolour -anchor -css docs\System.FilePath.Posix.hs   > docs\System.FilePath.Posix.html\r
-\r
-if "%1" == "deploy" copy "docs\*.*" "W:\projects\filepath\*.*"\r
-\r
diff --git a/push.bat b/push.bat
deleted file mode 100644 (file)
index d7a2471..0000000
--- a/push.bat
+++ /dev/null
@@ -1 +0,0 @@
-darcs push --no-set-default neil@darcs.haskell.org:/home/darcs/packages/filepath
\ No newline at end of file
diff --git a/readme.txt b/readme.txt
deleted file mode 100644 (file)
index 4a5eab5..0000000
+++ /dev/null
@@ -1,64 +0,0 @@
-System.FilePath
-===============
-
-I have written a System.FilePath module in part based on the one in
-Yhc, and in part based on the one in Cabal (thanks to Lemmih). The aim
-is to try and get this module into the base package, as FilePath's are
-something many programs use, but its all too easy to hack up a little
-function that gets it right most of the time on most platforms, and
-there lies a source of bugs.
-
-This module is Posix (Linux) and Windows capable - just import
-System.FilePath and it will pick the right one. Of course, if you
-demand Windows paths on all OS's, then System.FilePath.Windows will
-give you that (same with Posix). Written in Haskell 98 + Heirarchical
-Modules.
-
-Haddock: http://www-users.cs.york.ac.uk/~ndm/projects/filepath/System-FilePath.html
-Darcs: darcs get http://www.cs.york.ac.uk/fp/darcs/filepath
-Source: http://www.cs.york.ac.uk/fp/darcs/filepath/System/FilePath.hs
-Homepage: http://www-users.cs.york.ac.uk/~ndm/projects/libraries.php
-
-If you go to the haddock page there are a few little examples at the
-top of the file.
-
-
-Acknowledgements
-----------------
-
-Thanks to Marc Webber, shapr, David House, Lemmih, others...
-
-
-Competitors
------------
-
-System.FilePath from Cabal, by Lemmih
-FilePath.hs and NameManip.hs from MissingH
-
-The one from Cabal and FilePath.hs in MissingH are both very similar, I
-stole lots of good ideas from those two.
-
-NameManip seems to be more unix specific, but all functions in that module
-have equivalents in this new System.FilePath module.
-
-Hopefully this new module can be used without noticing any lost functions,
-and certainly adds new features/functions to the table.
-
-
-Should FilePath by an abstract data type?
------------------------------------------
-
-The answer for this library is no. This is a deliberate design decision.
-
-In Haskell 98 the definition is 'type FilePath = String', and all functions
-operating on FilePath's, i.e. readFile/writeFile etc take FilePath's. The
-only way to introduce an abstract type is to provide wrappers for these
-functions or casts between String's and FilePathAbstract's.
-
-There are also additional questions as to what constitutes a FilePath, and
-what is just a pure String. For example, "/path/file.ext" is a FilePath. Is
-"/" ? "/path" ? "path" ? "file.ext" ? ".ext" ? "file" ?
-
-With that being accepted, it should be trivial to write
-System.FilePath.ByteString which has the same interface as System.FilePath
-yet operates on ByteString's.
diff --git a/tests/test.bat b/tests/test.bat
deleted file mode 100644 (file)
index 8c71836..0000000
+++ /dev/null
@@ -1,44 +0,0 @@
-@echo off\r
-\r
-if "%1" == "help" goto help\r
-\r
-echo Generating test script\r
-runhaskell GenTests\r
-\r
-if "%1" == "hpc" goto hpc\r
-if "%1" == "ghci" goto ghci\r
-\r
-runhaskell -i.. -cpp -DTESTING FilePath_Test.hs\r
-goto end\r
-\r
-\r
-:ghci\r
-ghci -i.. -cpp -DTESTING FilePath_Test.hs\r
-goto end\r
-\r
-\r
-:hpc\r
-mkdir hpc 2> nul\r
-mkdir hpc\System 2> nul\r
-mkdir hpc\System\FilePath 2> nul\r
-type AutoTest.hs > hpc\AutoTest.hs\r
-type FilePath_Test.hs > hpc\FilePath_Test.hs\r
-cpphs --noline -DTESTING ..\System\FilePath\Posix.hs > hpc\System\FilePath\Posix.hs\r
-cpphs --noline -DTESTING ..\System\FilePath\Windows.hs > hpc\System\FilePath\Windows.hs\r
-pushd hpc\r
-ghc FilePath_Test.hs -o test --make -fhpc\r
-test\r
-hpc markup test.tix --exclude=AutoTest --exclude=Main\r
-hpc report test.tix --exclude=AutoTest --exclude=Main\r
-popd\r
-goto end\r
-\r
-\r
-:help\r
-echo FilePath tester script\r
-echo   test            Run the tests using runhaskell\r
-echo   test ghci       Run the tests using ghci\r
-echo   test hpc        Run the tests using hpc\r
-goto end\r
-\r
-:end\r