Hacker News new | ask | show | jobs
by dozzie 2876 days ago
> 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.

2 comments

"... 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.
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.
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 :(