README.md
1portal - Front-end to pkg(8)
2============================
3
4
5Screenshot
6==========
7
8![Portal](http://0xd0.org/portal.png "Portal")
9
10
11About
12=====
13
14portal is a front-end to FreeBSD's package manipulation tool pkg(8).
15It presents the user with a text-mode interface which comprises two
16main panels: one to browse the list of packages, and the other to
17display the currently selected package's comment line as found in
18the port's Makefile, together with its longer comment as found in
19the port's pkg-descr file.
20
21Three different modes are currently supported:
22
231. *browse* mode, with which the user sees the list of all packages
24 without any filtering
252. *search* mode, which allows to enter a string that will be used
26 to search the packages repository
273. *filter* mode, in which various filters can be toggled on or off
28 to narrow the list of packages to be displayed
29
30
31TODO
32====
33
34This is the list of items that should be worked on for future releases
35
36* portal should be made configurable using a ~/.portal.conf file
37* portal should use the libpkg directly instead of calling pkg(8)
38
39
40Additional resources
41====================
42
43* The Git repository of [portal is hosted on GitHub][1]
44* In order to share your thoughts about portal, you can join the
45 __#portal__ irc channel on EFnet.
46* If you hit a bug when using portal, you can submit an issue in the
47 [portal issue tracker][2].
48
49[1]: https://github.com/culot/portal
50[2]: https://github.com/culot/portal/issues
51