unclear setup / usage #3

Open
opened 2020-03-20 08:47:25 +01:00 by mixmix · 2 comments

I came from Scuttlebutt after being tipped (?) and look at this repo. The README looks simple : https://git.p2p.legal/axiom-team/ssb-g1like#an-ssb-user-sent-you-%C4%9F1-here-is-how-to-claim-it

But this doesn't work. Looks like I need base58 ... ok, so installed that via a snap ... then see install.sh and looks like there's heaps more to install ):

Solution
I recommend some possible sections are added to this repo:

  • Example Usage - how is this generally used once installed .. is it a CLI tool, or is this one-use only?
  • Installation - just tell people to run :
    $ ./install.sh
    
  • API - are there commands I run once this installed .. oh yeah, the secret2dunikey.sh . If this is the only thing run maybe this isn't an API section... think maybe this should be called install.sh and the current install is setup.sh ?

oh ... maybe that install is doing a heap of stuff .. it seems like it's starting an sbot and keeping it running ?!

I came from Scuttlebutt after being tipped (?) and look at this repo. The README looks simple : https://git.p2p.legal/axiom-team/ssb-g1like#an-ssb-user-sent-you-%C4%9F1-here-is-how-to-claim-it But this doesn't work. Looks like I need `base58` ... ok, so installed that via a snap ... then see `install.sh` and looks like there's heaps more to install ): **Solution** I recommend some possible sections are added to this repo: - Example Usage - how is this _generally_ used once installed .. is it a CLI tool, or is this one-use only? - Installation - just tell people to run : ```bash $ ./install.sh ``` - API - are there commands I run once this installed .. oh yeah, the `secret2dunikey.sh` . If this is the only thing run maybe this isn't an API section... think maybe this should be called `install.sh` and the current install is `setup.sh` ? oh ... maybe that install is doing a heap of stuff .. it seems like it's starting an sbot and keeping it running ?!
Member

Thanks a lot @mixmix for your feedback. I tried to improve the Readme.

Is it better this way?

Thanks a lot @mixmix for your feedback. I tried to improve the Readme. Is it better this way?
Owner

@mixmix great to see you here! Thanks for your survey...

It is true install is trying to run "sbot" background wich is not usefull if patchwork or another client (with bundled server) is used.

This behaviour "sbot/sbotc" is a configuration only for "headless" G1SSB nodes... For the G1 BLOB, a multichannel Bot using G1/SSB/IPFS https://git.p2p.legal/axiom-team/astroport where ssb-g1-tip is a module.

More detection have to be done... And a common install.sh

@mixmix great to see you here! Thanks for your survey... It is true install is trying to run "sbot" background wich is not usefull if patchwork or another client (with bundled server) is used. This behaviour "sbot/sbotc" is a configuration only for "headless" G1SSB nodes... For the G1 BLOB, a multichannel Bot using G1/SSB/IPFS https://git.p2p.legal/axiom-team/astroport where ssb-g1-tip is a module. More detection have to be done... And a common install.sh
Sign in to join this conversation.
No Label
No Milestone
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: axiom-team/ssb-g1-tip#3
No description provided.