Browse Source

Some updates to the readme re: new package system.

master
Abrax 3 years ago
parent
commit
2bb6a9ed0c
1 changed files with 1 additions and 45 deletions
  1. 1
    45
      README.md

+ 1
- 45
README.md View File

@@ -76,48 +76,6 @@ Make sure you have Python 3.6 and are using it to run `lizard`. Python 2 will ab

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
$ sudo tar -zvxf dist/lizard-0.1.1.linux-x86_64.tar.gz -C /
./
./usr/
./usr/lib/
./usr/lib/python3.6/
./usr/lib/python3.6/site-packages/
./usr/lib/python3.6/site-packages/db_methods.py
./usr/lib/python3.6/site-packages/constants.py
./usr/lib/python3.6/site-packages/__pycache__/
./usr/lib/python3.6/site-packages/__pycache__/json_methods.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/db_model.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/lizard.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/time_methods.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/constants.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/file_io.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/web_methods.cpython-36.pyc
./usr/lib/python3.6/site-packages/__pycache__/db_methods.cpython-36.pyc
./usr/lib/python3.6/site-packages/file_io.py
./usr/lib/python3.6/site-packages/lizard.py
./usr/lib/python3.6/site-packages/web_methods.py
./usr/lib/python3.6/site-packages/db_model.py
./usr/lib/python3.6/site-packages/json_methods.py
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/dependency_links.txt
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/PKG-INFO
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/top_level.txt
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/requires.txt
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/SOURCES.txt
./usr/lib/python3.6/site-packages/lizard-0.1.1-py3.6.egg-info/entry_points.txt
./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.

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.

@@ -130,9 +88,7 @@ If your existing `threads.orm.db` file causes problems, but a fresh one works fi

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

Python is supposed to be cross-platform so it should work on other OSes too. If anyone is actually interested in running it on something else, I can try to build for that also.
Since Python is cross platform it should run if Python runs, but I only use it on Linux so currently instructions are for that. They shouldn't be hard to adapt to other OSes, but if anyone is actually interested in running this on something else I can try to provide specific instructions.

### 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.

Loading…
Cancel
Save