Readme does not shows what this project does.

[jack17529]

Expected behavior

Should put precisely what this project does as the organisation is selected for GSOC 2017.

[oliverroick]

Hi @jack17529, would you care to elaborate what information you are missing?

[jack17529]

@oliverroick it's good that we have docs but what will happen when I run the project , the final output should be mentioned in the readme.md and what is it's significance. Other projects have it ,as far as I have seen.

[oliverroick]

but what will happen when I run the project , the final output should be mentioned in the readme.md

I'm not sure I understand. What do you mean when you say "the final output?" This project is a platform that you run on a server, there is a web interface and an API. "Running the project" will just start the web server (unless you run the tests). It's not like you run a commend in the shell, some input is processed and you get something back.

[jack17529]

@oliverroick sir,I only want to say that it should show in readme that it starts a server, and some features that it has okay.

[SteadyCadence]

@jack17529 Are you recommending an overall description of what the platform does (as supposed to what the setup in the Readme does)?

If so, would a GIF of the platform and basic capabilities of the platform suffice?

[SteadyCadence]

@olivierroick I can tackle this one.

[jack17529]

@SteadyCadence ,yes sir that' it,and would be nice.

[oliverroick]

This isn't a priority at the moment. Closing...