Update readme #87
Update readme #87
Conversation
| @@ -57,17 +57,21 @@ Installation | |||
| Any platform | |||
There was a problem hiding this comment.
Does this actually work on any platform?
There was a problem hiding this comment.
I don't think there's any platform-specific code. I know it's been used on Windows as well as *nixes.
There was a problem hiding this comment.
You're right, I checked the instructions on Windows and Linux.
| fido -h | ||
|
|
||
| Using pip | ||
| 1. Run `sudo pip install opf-fido` |
There was a problem hiding this comment.
Should this recommend sudo? It's likely to fail without it.
There was a problem hiding this comment.
"It depends", I think. It can work without sudo on some platforms and not others?
There was a problem hiding this comment.
Updated to suggest privilege escalation may be required.
| @@ -57,17 +57,21 @@ Installation | |||
| Any platform | |||
| 1. Download the latest zip release from https://github.com/openpreserve/fido/releases | |||
| 2. Unzip into some directory | |||
| 3. Open a command shell, cd to the directory that you placed the zip contents into and cd into folder 'fido' | |||
| 4. You should now be able to see the help text: | |||
| python fido.py -h | |||
There was a problem hiding this comment.
This generates an error because python handles relative imports differently.
Traceback (most recent call last):
File "fido.py", line 27, in <module>
from . import __version__, CONFIG_DIR
ValueError: Attempted relative import in non-package
From the unzip directory, python -m fido.fido may work, but requires ole to be installed first.
|
|
||
| Updating signatures | ||
| ------------------- | ||
|
|
||
| To update FIDO with the latest PRONOM file format definitions, run: | ||
| python update_signatures.py | ||
| fido-update-signatures |
There was a problem hiding this comment.
Should this also include the pythom -m fido.update_signatures suggestion? I'm not sure which cases it will work in.
Hwesta
force-pushed
the
update-readme
branch
5 times, most recently
from
fc3fe11 to
741ac9d
Compare
|
I can confirm that the installation instructions in this readme work as expected. |
Update installation instructions to include dependencies & fix problems with relative imports.
Converted from Windows newlines to UNIX newlines - I'm flexible on this and willing to convert back if there are objections.
Edit: Converted to markdown