DOCS: add README.md and HACKING.md
This commit is contained in:
parent
a1af66cac3
commit
9a344b63e8
29
HACKING.md
Normal file
29
HACKING.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
HACKING
|
||||||
|
=======
|
||||||
|
|
||||||
|
Coding style
|
||||||
|
------------
|
||||||
|
|
||||||
|
- match the sorroundings
|
||||||
|
- no overcomplicated pointfree style
|
||||||
|
- normal indenting 2 whitespaces
|
||||||
|
- just make things pretty and readable
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
__Everything__ must be documented. :)
|
||||||
|
|
||||||
|
Hacking Guide
|
||||||
|
-------------
|
||||||
|
|
||||||
|
The main data structure is in [DirTree.hs](src/Data/DirTree.hs), which
|
||||||
|
should be seen as a library. This is then mapped into the Gtk+ GUI at
|
||||||
|
[Gui.hs](src/GUI/Gtk/Gui.hs) and [Utils.hs](src/GUI/Gtk/Utils.hs).
|
||||||
|
|
||||||
|
File operations (like copy, delete etc) are defined at
|
||||||
|
[File.hs](src/IO/File.hs).
|
||||||
|
|
||||||
|
Note that the main data structures are still a bit in flux. Join
|
||||||
|
[the discussion](https://github.com/hasufell/hsfm/issues/12) on how to
|
||||||
|
improve them.
|
25
README.md
Normal file
25
README.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
HSFM
|
||||||
|
====
|
||||||
|
|
||||||
|
A Gtk+:3 filemanager written in Haskell.
|
||||||
|
|
||||||
|
Design goals:
|
||||||
|
|
||||||
|
- easy to use
|
||||||
|
- useful library interface to be able to build other user interfaces
|
||||||
|
- type safety, runtime safety, strictness
|
||||||
|
- simple add-on interface
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
```
|
||||||
|
cabal install
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
|
See [HACKING.md](HACKING.md).
|
Loading…
Reference in New Issue
Block a user