Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation instructions #22

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

joeflack4
Copy link

@joeflack4 joeflack4 commented Aug 25, 2022

Added installation instructions; for MacOS only at the moment.

Issue: #23

@jamesaoverton
Copy link
Member

Thank you for the doc improvements. I've been bitten by this code signing problem before, and it's good to mention it in the docs. Note that (at least for now) if you download a binary using curl (or wget or whatever) instead of your browser, then this problem is avoided. That's what I end up doing most of the time.

I moved this macOS advice up into the Usage section, reworded it, and added a command-line option. Do those changes work for you?

@joeflack4
Copy link
Author

The bit about the signature is a great change / addition. That's an improvement.

As far as installation goes, I would still like installation instructions. So that would include changing the line where I talk about downloading from the 'releases' page to a curl (so long as the URL is stable), and keep the bit about usr/local/bin. Doesn't have to be that path exactly; but should have some instructions that the user can follow so that they can reliably install and use.

@jamesaoverton
Copy link
Member

Sorry, I feel like I'm missing something: Doesn't the updated "Usage" section now cover all of your suggestions? Quoting:

Usage

  1. download the binary for your platform
    from the "Assets" section of the latest release on the
    Releases page.
  2. make sure that the binary is executable
  3. create a SQLite database file with a prefix table
  4. run rdftab with the database you want to use, and the RDFXML input as STDIN
  5. query your database with SQLite
$ curl -L -o rdftab https://github.com/ontodev/rdftab.rs/releases/download/v0.1.1/rdftab-x86_64-apple-darwin
$ chmod +x rdftab
$ sqlite3 example.db < test/prefix.sql
$ ./rdftab example.db < test/example.owl
$ sqlite3 example.db
> select * from statements limit 3;

If macOS complains about running untrusted code
(due to Gatekeeper code signing,
see allow permissions),
try sudo spctl --add rdftab.

@joeflack4
Copy link
Author

@jamesaoverton As sorry, I didn't even notice that. I usually don't see installation steps in the "usage" section; usually see that after installation / config is complete.

The steps which still seem to be left out are:

mv path/to/rdftab-x86_64-apple-darwin /usr/local/bin/rdftab
chmod 777 /usr/local/bin/rdftab

Do you know if sudo spctl --add rdftab will also solve the same permissions issue that chmod achieves? Haven't used it.

I like having some suggestion to make rdftab easily available on the path, e.g. /usr/local/bin/rdftab. It doesn't have to be exactly that though.

I just want to make sure that if I have anyone on new students on my team that I want to delegate things to, that they're able to install and set this up with minimal experience doing this sort of thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants