search

ao-data / albiondata-client

Distributed client for the Albion Online Data project.
https://www.albion-online-data.com/
MIT License
101 stars 30 forks source link

No explanation on how to use your client #114

Closed dw926 closed 2 months ago

dw926 commented 2 months ago

I'm not seeing anything here that helps to explain any of the following: 1) The client's intended use 2) How to properly start up the client 3) How to use this client

I don't really understand how anyone is able to make any use of your client. I was directed here from https://www.albion-online-data.com/ but I see no explanation of what I should expect when using this.

As it is, I downloaded the client which added an icon to my home screen. When I open up the icon, I see a brief window flash but no other obvious indicator that this client is running or operating. I otherwise have no idea what the client is doing or if it is even working at all, and I have no clue how to verify whether it is working.

This page needs instructions on how this software is actually used.

phendryx commented 2 months ago

You're not wrong, but, 1000's of people have also figured it out without instruction. We're open to PRs on the website here. There's numerous tasks that need to be completed for the project, documentation being only one of them, with only a small handful of people that maintain the project. There's also youtube videos of 3rd parties explaining it.

dw926 commented 2 months ago

I don't see this as a "documentation" issue and I certainly don't have some multi-page document in mind when I say this. I am just looking for the absolute basics. Even just a few sentences along the lines of "fire up the program from your desktop and it will run in the background" or "look at this location to ensure it is working correctly" would be extremely helpful.