aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 4f3b78964bea3e6d9aa1858941233e0c9731ecf4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
               __
  ___     ___ /\_\    ___     __
/' _ `\  / __`\/\ \  /'___\ /'__`\
/\ \/\ \/\ \L\ \ \ \/\ \__//\  __/
\ \_\ \_\ \____/\ \_\ \____\ \____\
 \/_/\/_/\/___/  \/_/\/____/\/____/
                                    -- by lostd and sin
=======================================================


What is it?
===========

noice is a small ncurses-based file browser.
It was first developed to be used with a tv remote control for a media
center solution.


Getting started
===============

Get the latest version from the git-repository; build and install it.  Run
noice in a directory to display its content in the form of a list, where
each line is a file or directory.  The currently selected item will be
preceded with a " > " by default.

For more information refer to the manpage.


Building
========

To build noice you need a curses implementation available.  In most
cases you just do:

    make

It is known to work on OpenBSD, Arch Linux, Slackware, NetBSD, IRIX.  Some notes
for building on certain systems follow.

 * NetBSD:

    make LDLIBS="-lcurses"

 * IRIX:

    make CC="gcc" LDLIBS="-lgen -lcurses"


Contact
=======

You can reach us through the freenode IRC network at #2f30.  If you have
any patches, ideas or feedback feel free to join.