Write documentation

[Te-k]

Write documentation :

• What is harpoon -> pictures and examples
• How to install it
• How to use it
• How to write plugins

[evilcel3ri]

Do you have any idea what part should be developed? A couple of screenshots and a cool ascii art would be nice to have. Nonetheless, I had not issue with the installation and the development in a virtualenv.

[Te-k]

I have started documentation on how to install it on the wiki. I think it would be nice to explain a bit more what you can do with it with video / screenshots before people go into the installation process

[evilcel3ri]

ok, !'ll check it out!

[XavCC]

Is it relevant to write some kind of advice for harpoon updates?

For example:

"When you want to update the harpoon: check and update your pip version; # /usr/bin/python -m pip install --upgrade pip Then update the harpoon # git pull origin master Then # pip3 install . and if, for example, a missing package appears ModuleNotFoundError: No module named "pygreynoisev1" do # pip install pygreynoisev1"

[evilcel3ri]

Hi!

Great idea, if you needed this, this means it's lacking from the current documentation.

I'll write something about it later today.

[evilcel3ri]

See https://github.com/Te-k/harpoon/pull/144

[XavCC]

Perfect! Thank you (>‿o)

[Te-k]

Hi @XavCC @christalib ,

I am not fully sure it is worth having that in the main documentation. This kind of error should not happen unless there is a problem with the setup.py (which may have happened, but hopefully not often). Maybe it is better to have that in the wiki and try to keep the main README short? @XavCC Did you have this issue recently? Is it working with the last version?

[Te-k]

I have added a part of that to the README and a part of it to the wiki, let me know what you think

[XavCC]

Hi and wish you all the best for this new year,

I Updated harpoon from changes applied in 7 Nov 2020 with the described trouble on 12 dec. 2020

According to my harpoon.egg-info/PKG-INFO, today :

Metadata-Version: 2.1
Name: harpoon
Version: 0.1.3

My case was the update from 0.1.3 to 0.1.5

If I am right the actual version is 0.1.6 according to the setup.py.

So just now, I tried to update to 0.1.6 with:

git pull origin master
pip install .

And tadam… pip install . did the job

And if I face problem I'll report here (only if it seems relevant).

And thank you to take care of the returns and to apply a documentation according to them :heart: