diff --git a/README.md b/README.md index 0e24547..25daa66 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ # Command Line Interface File Manager -Clifm is a small file manager written in Haskell with a command line interface. It allows you to explore directories in multiple Panes/Tabs and perform basic operations. +Clifm is a small file manager written in Haskell with a terminal-based interface. It allows you to explore directories in multiple Panes/Tabs and perform basic operations. ![screenshot](screenshot.png) -> Note: this is still an experiment. Directory navigation will do no harm, but think twice before starting operations on your file system. I take no responsibility for what you do with this software. +> Note: this is still an experiment. Directory navigation will do no harm, but double-check before starting operations on your file system. I take no responsibility for what you do with this software. -## Building and Running -To install clifm, you need [GHC](https://www.haskell.org/ghc/) and [cabal-install](http://hackage.haskell.org/package/cabal-install). +## Installation +For ArchLinux the binary from [the latest github release](https://github.com/pasqu4le/clifm/releases/latest) should work. +For other Linux distro the binary may work as well, or you can build from source. -From the downloaded source code directory you can then use: +To build from source you will need [GHC](https://www.haskell.org/ghc/) and [cabal-install](http://hackage.haskell.org/package/cabal-install). +Since clifm is on Hackage you can just use: ``` +$ cabal install clifm +``` +or install from the cloned repository: +``` +$ git clone https://github.com/pasqu4le/clifm.git +$ cd clifm $ cabal install ``` diff --git a/clifm.cabal b/clifm.cabal index 553d4b7..1e999e7 100644 --- a/clifm.cabal +++ b/clifm.cabal @@ -16,7 +16,7 @@ version: 0.3.1.0 synopsis: Command Line Interface File Manager -- A longer description of the package. --- description: +description: A terminal-based File Manager with multiple panes/tabs interface, basic file operations and mouse support. -- URL for the project homepage or repository. homepage: https://github.com/pasqu4le/clifm @@ -43,11 +43,14 @@ build-type: Simple -- Extra files to be distributed with the package, such as examples or a -- README. -extra-source-files: ChangeLog.md +extra-source-files: README.md -- Constraint on the version of Cabal needed to build this package. cabal-version: >=1.10 +source-repository head + type: git + location: git://github.com/pasqu4le/clifm.git executable clifm ghc-options: -threaded diff --git a/screenshot.png b/screenshot.png index 8daf6c5..7a08a06 100644 Binary files a/screenshot.png and b/screenshot.png differ