search

papis / papis-zotero

Zotero compatibility layer for papis
GNU General Public License v3.0
75 stars 17 forks source link

docs: update readme #50

Closed jghauser closed 6 months ago

jghauser commented 6 months ago

Fixed a couple of things in the readme:

I think we should still improve this by saying what's the best option. At the moment there are two import options and no indication which one is preferred.

alexfikl commented 6 months ago

This looks good to me! Let me know when you think it's ready to merge from your side as well.

As for a preferred method, I'm not really sure, since I've never actually used this to do an import. I would vote for the SQL method, since that has access to all of Zotero's metadata, in case they ever decide to skip on some things in the BibTeX export.

jghauser commented 6 months ago

As for a preferred method, I'm not really sure, since I've never actually used this to do an import. I would vote for the SQL method, since that has access to all of Zotero's metadata, in case they ever decide to skip on some things in the BibTeX export.

Yeah, I also haven't used this in a long time, so I'm unsure. Maybe @kiike has an idea?

kiike commented 6 months ago

SQL for sure should be the preferred option. I think the only reason to not use it would be either if you are somehow getting import problems or if you're afraid the import process will eat your data. I really can't think of another scenario.

jghauser commented 6 months ago

thanks both of you for your input @alexfikl and @kiike. i'm gonna re-organise the readme so the preferred option is clearly indicated and at the top!

jghauser commented 6 months ago

ok, i think this is done. I also moved the development information to the bottom, so that the info useful to users comes first.

alexfikl commented 6 months ago

Looks a lot nicer! Thank you :grin:

There's some new nix stuff on main from #49. Can you update the PR with that and also move it to the Development section?

jghauser commented 6 months ago

Ok will do. I'll leave the stuff that relates to installing on nix with the flake in the installation section and add a bit on the devshell in the development section

jghauser commented 6 months ago

That's all done now! :)

alexfikl commented 6 months ago

Perfect! Thank you! :rocket: