Doing a new OSS tool to help self-hosting edgerq - feedback for
documentation/Readme
reddit / selfhosted

----------------------------------------------------------------------
VysokoAnime · 2023-10-11 12:43

Hi. I think I'm doing a lousy job at creating documentation/Readme for
a new tool I'm working on - edgerq - the work in progress doc is at [h
ttps://docs.google.com/document/d/1cyV53YJ7zqwwvkqa6V\_BjkrHmDyqO6hh5\
_m5emyCLjs/edit?usp=drive\_link](https://docs.google.com/document/d/1c
yV53YJ7zqwwvkqa6V_BjkrHmDyqO6hh5_m5emyCLjs/edit?usp=drive_link) \- and
I believe that I am failing to explain it in a single paragraph and/or
in short-form. I'm enabling comments on the document in case you'd
like to comment/ask questions. When it comes to the GitHub repository
- I still need to make a simple howto on how to compile and run it.
There are scripts included to compile the bits and pieces with minimum
dependencies, but there is really not much explanation.

----------------------------------------------------------------------
Fluffer_Wuffer · 2023-10-11 13:55

You need to explain Edgerq.. Is it an app that talks to Dolphins?

You're first sentence basically comes over as "I can't be bothered", I
know this is not what you mean, but that is how it comes across. Even
worse, when we look at the repo there is zero explanation. My advise
is add

* what is it
* how it works
* who might want to use it
* how to use it

----------------------------------------------------------------------
VysokoAnime · 2023-10-11 14:03

Oh yes true - I would like to add a propper Readme & more details to
the repo - and the Google docs file is my work in progress. I didn't
want to copy that 1:1 without feedback.

Thanks for the points.