Skip to content

Commit

Permalink
added section [4] on future improvements and removed +w permission fr…
Browse files Browse the repository at this point in the history
…om readme.txt
  • Loading branch information
pkrumins committed Nov 28, 2009
1 parent 3fe6b46 commit 1c7cc3f
Showing 1 changed file with 83 additions and 76 deletions.
159 changes: 83 additions & 76 deletions readme.txt
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,76 +1,83 @@
This is the Hacker Top program. It's a top-like program for monitoring stories
on hacker news (news.ycombinator.com) from the console.

It was written by Peteris Krumins (peter@catonmat.net).
His blog is at http://www.catonmat.net -- good coders code, great reuse.

The code is licensed under the GNU GPL license.

The code was written as a part of the article "Follow Hacker News from the
Console" on my website. The whole article can be read at:

http://www.catonmat.net/blog/follow-hacker-news-from-the-console/

------------------------------------------------------------------------------

Table of contents:

[1] The Hacker Top program.
[2] Program's usage.
[3] Keyboard shortcuts.


[1]-The-Hacker-Top-program----------------------------------------------------

This program monitors the Hacker News website ( http://news.ycombinator.com )
for hacker stories and displays them in the console via ncurses.

The program is written in Python programming language and is supposed to
be run on Unix type operating systems, such as Linux.

It uses one external Python module - BeautifulSoup - for parsing HTML.
BeautifulSoup can be downloaded from http://crummy.com/software/BeautifulSoup
or via `easy_install beautifulsoup`

See my original article for a screenshot:

http://www.catonmat.net/blog/follow-hacker-news-from-the-console/


[2]-Hacker-Top-usage----------------------------------------------------------

Usage: ./hacker_top.py [-h|--help] - displays help message

Usage: ./hacker_top.py [-i|--interval interval]
[-u|--utf8 <on|off>] [-n|--new]

-i or --interval specifies refresh interval.
The default refresh interval is 3 minutes. Here are a few
examples: 10s (10 seconds), 12m (12 minutes), 2h (2 hours).

-u or --utf8 turns on utf8 output mode.
Default: off. Use this if you know for sure that your
terminal supports it, otherwise your terminal might turn into garbage.

-n or --new follows only the newest hacker stories.
Default: follow front page stories.


[3]-Keyboard-shortcuts--------------------------------------------------------

q - quits the program.
u - forces an update of the stories.
m - changes the display mode.
up/down arrows (or j/k) - scrolls the news list up or down.


------------------------------------------------------------------------------


Have fun using it!


Sincerely,
Peteris Krumins
http://www.catonmat.net

This is the Hacker Top program. It's a top-like program for monitoring stories
on hacker news (news.ycombinator.com) from the console.

It was written by Peteris Krumins (peter@catonmat.net).
His blog is at http://www.catonmat.net -- good coders code, great reuse.

The code is licensed under the GNU GPL license.

The code was written as a part of the article "Follow Hacker News from the
Console" on my website. The whole article can be read at:

http://www.catonmat.net/blog/follow-hacker-news-from-the-console/

------------------------------------------------------------------------------

Table of contents:

[1] The Hacker Top program.
[2] Program's usage.
[3] Keyboard shortcuts.
[4] Future TODO improvements.


[1]-The-Hacker-Top-program----------------------------------------------------

This program monitors the Hacker News website ( http://news.ycombinator.com )
for hacker stories and displays them in the console via ncurses.

The program is written in Python programming language and is supposed to
be run on Unix type operating systems, such as Linux.

It uses one external Python module - BeautifulSoup - for parsing HTML.
BeautifulSoup can be downloaded from http://crummy.com/software/BeautifulSoup
or via `easy_install beautifulsoup`

See my original article for a screenshot:

http://www.catonmat.net/blog/follow-hacker-news-from-the-console/


[2]-Hacker-Top-usage----------------------------------------------------------

Usage: ./hacker_top.py [-h|--help] - displays help message

Usage: ./hacker_top.py [-i|--interval interval]
[-u|--utf8 <on|off>] [-n|--new]

-i or --interval specifies refresh interval.
The default refresh interval is 3 minutes. Here are a few
examples: 10s (10 seconds), 12m (12 minutes), 2h (2 hours).

-u or --utf8 turns on utf8 output mode.
Default: off. Use this if you know for sure that your
terminal supports it, otherwise your terminal might turn into garbage.

-n or --new follows only the newest hacker stories.
Default: follow front page stories.


[3]-Keyboard-shortcuts--------------------------------------------------------

q - quits the program.
u - forces an update of the stories.
m - changes the display mode.
up/down arrows (or j/k) - scrolls the news list up or down.


[4]-Future-TODO-improvements--------------------------------------------------

* Add a feature to open a story in web browser. (Someone suggested to use
webbrowser module)


------------------------------------------------------------------------------


Have fun using it!


Sincerely,
Peteris Krumins
http://www.catonmat.net

0 comments on commit 1c7cc3f

Please sign in to comment.