Make documentation better #20

Open
opened 2021-10-06 16:04:20 +02:00 by pranav · 3 comments
Owner

This issue is a place to make README.md, CHANGELOG.md, HACKING.md, docstrings and comments better.

This issue is a place to make README.md, CHANGELOG.md, HACKING.md, docstrings and comments better.
pranav added the
enhancement
help wanted
labels 2021-10-06 16:04:20 +02:00
Author
Owner

Pushing a small update in the README related to the minimum debian version directly to master

Pushing a small update in the README related to the minimum debian version directly to `master`
Author
Owner

We still don't have installation instructions for openSUSE. Anyone using opensuse here? And I have not tested pybatmesh on debian, ubuntu or fedora so the installation instructions in the README may be wrong.

We still don't have installation instructions for openSUSE. Anyone using opensuse here? And I have not tested pybatmesh on debian, ubuntu or fedora so the installation instructions in the README may be wrong.
Author
Owner

The similar projects section in README looks a bit like an advertisement of pybatmesh. It make pybatmesh sound more awesome than it actually is. We could remove all self promotion from the README

The similar projects section in README looks a bit like an advertisement of pybatmesh. It make pybatmesh sound more awesome than it actually is. We could remove all self promotion from the README
Sign in to join this conversation.
No Milestone
No project
No Assignees
1 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: pranav/pybatmesh#20
No description provided.