quassy / elementary-apps

A website showcasing 3rd party software designed for elementary OS 0.3 Freya
https://quassy.github.io/elementary-apps/
Other
113 stars 164 forks source link

Add installation instructions on all apps? #6

Open inputsh opened 9 years ago

inputsh commented 9 years ago

Basically, my idea is to create installation instructions in all apps in the same way it is done here.

quassy commented 9 years ago

That is planned, at least if the app has a PPA, .deb package or is in the official sources. The apps that are missing installation instructions either do not have any of that or I could not find it (help wanted!).

I am not sure yet if build instructions should be included, they are clearly aimed at more pro users (who can find them themself) and might change too often.

inputsh commented 9 years ago

I agree with you on 100% on that one.

PerfectCarl commented 9 years ago

I agree too. I filed quite a number of issues to launchpad projects that doesn't provide screenshot or installation instructions.

I think that we should pester app developers to add up to date changelog and build instructions. I'm not sure that those should be included in the list but then again why not?

Elementary third party projects (and even the first party ones) lack consistency and this list is a big important first step in that direction.

Using badges along the apps could be a nice way to encourage developers to provide missing screenshots, install/build instructions etc. I am not sure about the labeling but things like displaying badgesready for install or ready for contribution in the list might work on the developer's pride (or the application mosts passionate users). Gosh my labels are not good.

Hopefully you get the idea.

quassy commented 9 years ago

So you mean badges like "stable version available", "unstable version available", "looking for programmers", "looking for translators" (not sure if those are the best choice, but I'm using Octicons right now so the choice is limited).

up to date changelog and build instructions

Mirroring change logs and build instructions always means there is some delay from developer changing something and elementary apps actually showing it. And it means checking quite a few pages as most developers probably wouldn't bother to inform me.

Elementary third party projects (and even the first party ones) lack consistency and this list is a big important first step in that direction.

For smaller apps I also think the app pages (example) could become replacements for own dedicated webpages, so the maintainer does not have to waste too much time on making his own site.

PerfectCarl commented 9 years ago

And it means checking quite a few pages as most developers probably wouldn't bother to inform me.

You are right. What I meant was simply check once that the repository has those files (changelog and build instructions). Displaying those files/instructions here might not be necessary (as those are developer specific and don't concern most users - and would end up clogging your clean design).

My main idea was to mimic how stackoverflow incited developers to improve their communication game by providing clear and helpful answers/documentation with badges, points.

Rewarding app developers that went the extra mile with providing documentation is a way to improve the status quo and show developers that those things counts and are valued by the community. The community of developers that can propose fix faster (now that they don't have to fumble for doc or changes) and the users. (More fixes meaning more stable apps and a lesser risk of a useful app being orphaned).

to waste too much time on making his own site.

Once again, much agreed. After writing an app the last thing a developer want is to write a complete site web to get the word out there. And as website design, you are pretty good at it:)

So I think that your initiative has everything to be much loved by app developers everywhere. At least I feel that way.

quassy commented 9 years ago

I think for now I will add a list of developer links to certain special files: Readme, Install (or Build), License (or Copying), Authors, News (or Changes, Changelog). Copying that info seems too much work and "gamification" is hard with Jekyll (static pages), so only an option for version 2.