search

foss-np / batti

:bulb: load-shedding schedule for terminal!
Other
19 stars 12 forks source link

Too many stuffs in readme, move to wiki instead #33

Closed samundra closed 6 years ago

samundra commented 8 years ago

Suggestion

There are just too many instructions in the Readme and it confuses the general user. How about cleaning it up and keeping only installation part in the Readme? We can move rest of the parts to Wiki.

What do you guys think about it? @rhoit @krazedkrish @zerOnepal @hardfire @munikarmanish

rhoit commented 8 years ago

@samundra may be! I don't have pretty good perspective since I don't look though the eye of the user.

samundra commented 8 years ago

The readme document is very thorough for developers but for someone who is willing to give it a try it's confusing. May I refactor the readme for ubuntu users?

rhoit commented 8 years ago

ya we could write the wiki, but there is not much of content for the wiki pages, you are always welcomed to create one.

samundra commented 8 years ago

I will try to restructure the readme someday. Lets keep this issue open.

hardfire commented 8 years ago

Awesome, looking forward to the changes and I'll try to build and run it once to get a user perspective to it !

Regards, Avinash

On 12 Mar 2016, at 6:06 PM, Samundra notifications@github.com wrote:

I will try to restructure the readme someday. Lets keep this issue open.

— Reply to this email directly or view it on GitHub.

krazedkrish commented 8 years ago

I think the current read me is not bad. If wiki is to be added, i dont know how it can be good. My analysis is the following topics

Setting up Dependencies Install -Arch -Ubuntu -Building deb -Manual HOW-TO USE

are required in Readme. Except these there is only a few to be removed.

Since, the content is so little, i believe, either we should wait for the readme to increase, or we should add more contents in wiki to separate articles from read me and wiki.

samundra commented 8 years ago

In my opinion the current readme has enough informations for developers. We have to make it such that it can be easily installed by newbie too. That's what I am intending by proposing to moving contents to wiki on their own topics. e.g. 1) Installation

Wiki may not be the first place to have these sort of information but we can always keep adding contents to it.

Thanks,

On Mon, Mar 14, 2016 at 3:15 PM, Shalil Awaley notifications@github.com wrote:

I think the current read me is not bad. If wiki is to be added, i dont know how it can be good. My analysis is the following topics

Setting up Dependencies Install -Arch -Ubuntu -Building deb -Manual HOW-TO USE

are required in Readme. Except these there is only a few to be removed.

Since, the content is so little, i believe, either we should wait for the readme to increase, or we should add more contents in wiki to separate articles from read me and wiki.

— Reply to this email directly or view it on GitHub https://github.com/foss-np/batti/issues/33#issuecomment-196223883.

With best regards, Samundra Shrestha http://www.samundra.com.np Mobile: +977-9851236069

rhoit commented 8 years ago

I have restructured the README, and but stills has lots of blank to be filled. @samundra what kinda Troubleshooting, do you need.

krazedkrish commented 8 years ago

Samundra's suggestion sounds good. :+1:

I vote for " Let's start with it." :)

And we can also discuss what topics to leave in the read me.

krazedkrish commented 8 years ago

Mobile interface ma comment thich na khojda close vayechaa sorry guys.

rhoit commented 8 years ago

@samundra there has been lots of changes, if it address your problem, please close the issue.

samundra commented 8 years ago

@rhoit I will go through them tonight and hopefully I can close it. :+1: @krazedkrish

samundra commented 6 years ago

Project abandoned. Closing the thread.