[gioscarab]

Ciao dozzie, I have omitted "implementation" from the title because I thought that was obvious enough. It seems not.

The project proposes both an independent research in defining a specification, and also an open-source implementation based on that specification.

If you want to know what it does, read the specifications or at least the first sentences of the README :)

"PJON® (Padded Jittering Operative Network) is an Arduino compatible, multi-master, multi-media network protocol. It proposes a Standard, it is designed as a framework and implements a totally software emulated network protocol stack that can be easily cross-compiled on many architectures like ATtiny, ATmega, ESP8266, ESP32, STM32, Teensy, Raspberry Pi, Linux, Windows x86 and Apple machines. It is a valid tool to quickly and comprehensibly build a network of devices. Visit wiki and documentation to know more about the PJON Standard."

[plainOldText]

I think the OP’s critique of your README being vague is fair. Although judging from the downvotes, he comes across a little harsh.

Your README is needlessly abstract. It’s tantamount to saying you’ve invented a new wheel.

Well, wheels have all sorts of specifications, they're made of various materials, can have different weights, etc. They also have all sorts of use cases. From plastic wheels used in toys, rubber wheels used in cars, all the way to various wheels used for the construction of a rocket.

Although conceptually the wheel is an object that allows for easy rotation, you wouldn't use a plastic toy wheel for the construction, say of an automobile, would you? Also, not all wheels are used as rotary devices. Some can be used for just support.

Going back to your network protocol. What does this protocol allow one to do? What can it be used for? Be specific!

[gioscarab]

PJON is a general purpose "wheel" designed to work on a "charriot" (ATtiny85) as well as on a "formula 1" (real time operative system like linux, winx86, macosx). It has an "all weather tire" able to run on "mud", "tarmac" and "sand" (it operates layer 2 or the data-link agnostically).

Probably for this reason the README seems too general and not specific. The protocol is made NOT to be specific and its implementation is done to be executed (the same codebase) everywhere being 100% software "defined" or "emulated".

see: https://www.pjon.org/why.php

[dozzie]

> Ciao dozzie, I have omitted "implementation" from the title because I thought that was obvious enough. It seems not.

Keep the proper terminology. If you omit words left and right, it becomes incomprehensible garbage.

> If you want to know what it does, read the specifications

The whole point of README is to say what it does so I don't need to read specification that will be useless to me.

> or at least the first sentences of the README :)

I read it. The wall of words you cited says nothing about what it does and what purpose it serves.

[gioscarab]

"... is an Arduino compatible, multi-master, multi-media network protocol. It proposes a Standard, it is designed as a framework and implements a totally software emulated network protocol stack that can be easily cross-compiled on many architectures like ATtiny, ATmega, ESP8266, ESP32, STM32, Teensy, Raspberry Pi, Linux. It is a valid tool to quickly and comprehensibly build a network of devices". If this is a wall of words that says nothing about what the project is for, we are not from the same universe. And also, I don't think an omitted word in a title that must be short will make all the project an incomprehensible garbage, considering the amount of time and effort has been invested in docs and specs.

[detaro]

Immediately after the blurb is a section with key properties/selling points, which among other things explains the "multi-media" part. The wording of the description and readme isn't perfect (I suspect the author is not a native english speaker?), but it does contain the details necessary.

[gioscarab]

Ciao Detaro, thank you for your comment. Could you please point out the incosistencies you have found? I would be happy to fix that, yes I am not a native english speaker sadly :(