Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Repository #70

Open
jvolker opened this issue Oct 21, 2019 · 2 comments
Open

Rename Repository #70

jvolker opened this issue Oct 21, 2019 · 2 comments

Comments

@jvolker
Copy link
Collaborator

jvolker commented Oct 21, 2019

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

@jmwohl
Copy link
Member

jmwohl commented Oct 21, 2019

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.

@jvolker
Copy link
Collaborator Author

jvolker commented Oct 21, 2019

Yeah, all valid points, I think.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants