Browse Source

Minor readme corrections.

master
Abrax 3 years ago
parent
commit
8f7499a956
1 changed files with 2 additions and 19 deletions
  1. 2
    19
      README.md

+ 2
- 19
README.md View File

@@ -2,9 +2,7 @@
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

### 0.3 (in development)

This version will change syntax for some commands:

* Database creation: `lizard c` becomes `lizard create`
@@ -16,7 +14,6 @@ This version will change syntax for some commands:
These changes take effect with version 0.3 so be ready to update your scripts!

### 0.2 (current)

* Help message now shows version. (issue #24)
* New command: `rl` is refresh + list
* New command: `ro` is refresh + open in browser
@@ -24,42 +21,33 @@ These changes take effect with version 0.3 so be ready to update your scripts!
* Better handling of non-existent/invalid database.

### 0.1.1

* Now explicitly specifying python3 in script header, so it shouldn't attempt running with python2.
* `lizard e` output format matches the new packaged system.

### 0.1

- Introduced package system.

## Installation

### Linux

1. Download the most recent package from under `dist/`
2. Extract this into your root directory: `sudo tar -zvxf lizard-<VERSION HERE>.linux-x86_64.tar.gz -C /`

If you don't have the most recent Python3 installed and run into a problem, update your Python3 installation and try again.

### Upgrading

If you've been using Lizard for a while and are upgrading to a new release, be very careful with your local data. When a new version changes the database code or how local files are stored, it could fail to read your old shit and even corrupt it. I try to note this somewhere when it happens, but I may forget or you may not see the announcement. If in doubt, backup everything (all of Lizard's data is stored under `~/lizard_data/`) before trying the new version.

If you know for sure that a version breaks backwards compatibility, you have the following options:

* Just fuck it and start over with fresh database.


* Just say fuck it and start over with fresh database.
* Run `lizard e` in your old lizard, save the resulting file, install the new version and then re-construct your watch list by running the exported commands. If you had any unseen replies or something you might lose those, so I'd check first with `lizard r` and `lizard l`. It might also re-download the old files if I changed where the files are stored. If you can figure out where they are *supposed* to go you can copy them over to avoid the re-downloading.
* Open the databases in another program (see FAQ) and manually migrate the data.
* Beg me to make a migration script.

### Running sources directly

You can also run the `.py` files in the repo directly. If you want to do this I'm assuming you have enough proficiency with Python to figure it out. FYI, I use PyCharm to develop so it might be easier to get it to work with it.

## Usage

Running `lizard` without any arguments will print the help message explaining the syntax. It will also create a `~/lizard_data` directory to store files.

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.
@@ -67,13 +55,11 @@ After you install, run `lizard c` to create a new database (if you don't have on
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/`.

## Troubleshooting

Make sure you have Python 3.6 and are using it to run Linux. Python 2 will absolutely not run it, and the libraries I use may cause problems with older versions of Python 3.
Make sure you have Python 3.6 and are using it to run `lizard`. Python 2 will absolutely not run it, and the libraries I use may cause problems with older versions of Python 3.

I generate the release archive with Python's `distutils`. I have no idea how it deals with dependencies on other Python packages. You can install these with `pip install <package name>`. Off the top of my head you need `peewee` and `humanize`. I also use `os`, `shutil`, `webbrowser`, `json`, `requests` and `re` but these should be included in Python3 by default.

### Installation problems

Untarring the archive should produce something like this:

```bash
@@ -109,7 +95,6 @@ $ sudo tar -zvxf dist/lizard-0.1.1.linux-x86_64.tar.gz -C /
./usr/lib/python3.6/site-packages/time_methods.py
./usr/bin/
./usr/bin/lizard
$
```

As you can see this puts a link to the program under `/usr/bin/lizard` and all the program code under `/usr/lib/python3.6/site-packages/` . Confirm that the files are actually there, if not, first figure out where they went, delete them, and then manually extract and move the archive contents to these locations. The archive is generated with absolute paths as they should be on your system, so consult these (or the above list) when verifying that you've got everything where it needs to be.
@@ -117,7 +102,6 @@ As you can see this puts a link to the program under `/usr/bin/lizard` and all t
Alternatively you can try running the scripts with the interpreter. Just clone or download the repo, then navigate to the directory, and run `python3 lizard.py`. If that prints the help message then try other troubleshooting steps except replace `lizard` with `python3 lizard.py` in the commands.

### Does Lizard work at all?

Simply running `lizard` without any commands will print a help message (and also ensure that `~/lizard_data/` exists). If you can't get this to happen, the problem is probably your environment.

Next, try to run `lizard c`. It should create a new database, but if one already exists you need to get rid of it (either delete or rename). `lizard b` will back up the DB for you, but it won't erase the current one. Make sure the database it creates is `~/lizard_data/threads.orm.db` and not somewhere else.
@@ -128,7 +112,6 @@ If `lizard c` is able to create a database, then see if you can add a thread. Tr
If your existing `threads.orm.db` file causes problems, but a fresh one works fine, either your database is just fucked or one of the threads in it is causing problems. You can elminate the latter possibility by re-adding the threads to the fresh database. If there's a thread that consistently causes problems, congratulations, you found a bug! Submit an issue and wait for me to fix it, meanwhile don't add that thread. If you manage to re-add all the threads to the fresh database and everything works, just delete the old database and forget about it. Life's too short, man.

## FAQ

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


Loading…
Cancel
Save