Openframe icon indicating copy to clipboard operation
Openframe copied to clipboard

Rename Repository

Open jvolker opened this issue 5 years ago • 2 comments

The headline of this repository currently reads "Openframe Frame Controller". I find this current name misleading as I understand this repository more as the (Raspberry Pi) client of Openframe. The web app, on the other hand, feels like the controlling part to me.

Also, the repository URL is called "Openframe". In my opinion, this is not ideal either as this is only a small part of a larger system.

I suggest to rename it to "Openframe Client". I also suggest changing the repository URL to "Openframe-Client".

jvolker avatar Oct 21 '19 20:10 jvolker

This one I don't entirely agree with — in a typical API / Client architecture, the web app is as much a 'client' as the software that runs on the frame.

The code in this repository is in fact the software 'controlling the frame' in a very literal sense. I understand how from an app user (i.e. non engineering) perspective the web app can be seen as the 'controller' for the frame, but since the code repositories are for engineers I don't think that's too important.

All of that said, I'm not opposed to some renaming of components for clarity — but since any external application that talks to the server could be considered a client, I don't think calling this repo Openframe-Client adds clarity.

jmwohl avatar Oct 21 '19 22:10 jmwohl

Yeah, all valid points, I think.

How about something more verbose and similar to Openframe-Display-Controller?

jvolker avatar Oct 21 '19 22:10 jvolker