Browse Source

Cleaned up readme.

Signed-off-by: Abrax <abrax@teknik.io>
master
Abrax 3 years ago
parent
commit
e9d2e93c67
1 changed files with 12 additions and 9 deletions
  1. 12
    9
      README.md

+ 12
- 9
README.md View File

@@ -1,5 +1,5 @@
# lizard, the 8ch monitor
lizard is a command line (CLI) program for monitoring 8ch threads. After you add a thread to its watchlist, it can connect to 8ch and check if new replies were made, notifying you if so. It will attempt to save the thread and the files in it in case the thread dies. It can also open all threads with new replies in your browser with a single command.
# Lizard, the 8ch monitor
Lizard is a command line (CLI) program for monitoring 8ch threads. After you add a thread to its watchlist, it can connect to 8ch and check if new replies were made, notifying you if so. It will try to keep a local copy of the thread and the files in it in case the thread dies. It can also open all threads with new replies in your browser with a single command.

## Changelog

@@ -34,8 +34,9 @@ Running `lizard` without any arguments will print the help message explaining th

After you install, run `lizard c` to create a new database (if you don't have one already). Everything else will crash unless a valid database exists.

Add a thread to the database with: `lizard a <URL>` Upon adding a thread, `lizard` will immediately download a copy of the thread and the files in it. These will be put under `/data/` inside the directory where you put the `lizard` scripts.
Add a thread to the database with `lizard a <URL>`. Upon adding a thread, Lizard will immediately download a copy of the thread and the files in it. These will be put under `~/lizard_data/`.
## FAQ

### Is `lizard` only for Linux?
It's easy for me to build the Linux package, so I only supply that.

@@ -44,17 +45,19 @@ Python is supposed to be cross-platform so it should work on other OSes too. If
### Is there a GUI?
No. An earlier version of this program had a GUI, but it turned out to be more trouble than it's worth.

### Why doesn't `lizard` automatically refresh threads at set intervals?
Since Linux systems already have ways of scheduling automatic execution of programs, such as `cron`, I deliberately left out this feature. You can set a scheduled job that runs `lizard rc` at a frequency that suits you. You might also want to redirect output to your own log file so that you can later see what happened.
### Why doesn't Lizard automatically refresh threads at set intervals?
The user is expected to use the scheduling system of their OS to accomplish this.

For instance, on Linux you can set up `cron` to run `lizard rc` regularly, and maybe redirect output to your own log file as well.

### How can I see what's in the database?
`lizard l` will print out a summary, but if you want the nitty gritty I recommend the SQLite browser `sqliteman`. You can see the tables and alter them as you wish.
### How can I inspect the database?
`lizard l` will print out a summary, but if you want the nitty gritty you need a SQLite browser such as [SQLiteStudio](http://sqlitestudio.pl/) or [sqliteman](https://sourceforge.net/projects/sqliteman/).

### Why does it create so many `.json` and `.html` files in the data directory?
These are saved at each refresh in case the thread dies or any replies are deleted. Periodically clearing the older files is left up to the user.
These are saved at each refresh in case the thread dies or any replies are deleted. Deleting these files when they are no longer needed is the user's responsibility.

### How do you handle file names?
I use the original filenames with the first 10 characters of 8chan's hash-based name. Adding the hash is necessary because 8ch allows duplicate filenames in the same thread, so this was the most obvious way of keeping these files on disk.
I use the original filenames with the first 10 characters of 8chan's hash-based name. Adding the hash is necessary because 8ch allows duplicate filenames in the same thread, and they would otherwise conflict with each other when saved with the original name.

### How does the conservative refresh predict replies?
If the last reply was `x` seconds ago, and the thread was last refreshed `y` seconds ago, `lizard` doesn't bother refreshing unless `x/y>10`. Internally, the 10 is called `conservative_refresh_criterion`. Increasing this will make it less conservative, decreasing will make it more conservative.

Loading…
Cancel
Save