Skip to content

Modifications to README.md #10

Closed
wants to merge 2 commits into from

2 participants

@kjellwinblad

Fixed small typo and made it more clear that the UI has to be built before it is started.

kjellwinblad added some commits Feb 13, 2013
@kjellwinblad kjellwinblad Changed runbench to bencherl e9622e4
@kjellwinblad kjellwinblad Specified that it is necessary to run `make ui` again if bencherl is
moved to another path. Made it more clear that the ui has to be built
with `make ui` before it is started.
8431c6f
@yiannist yiannist was assigned Feb 15, 2013
@yiannist
Software Engineering Laboratory member

Hi Kjell!

The first commit is obviously correct. About the second commit: we don't think that we should add such details in the README.md. Maybe some FAQ.md or FAQ-page in the wiki is more appropriate for this. However, we do believe that the bencherl use is rather obvious. Do you think that the instructions need any clarification?

@kjellwinblad

Hi Yiannis, I think it can be useful to point out that you have to run make ui before starting the ui because it might be easy to think that it is built when you run make. I know that there is a section with instructions on how to built the ui but it might be easy to miss. Maybe it is best to reference that section from the section about how to run the ui. Feel free to do what you think is more suitable. I don't think it is very urgent, so it is ok for me if you leave it as it is.

@yiannist
Software Engineering Laboratory member

I'll leave it as is for now and change the README.md ASAP to make things more clear! :-D I don't really like the way it is structured today; it was @k4t3r1n4 's idea!

Thanks!

@yiannist yiannist closed this Feb 15, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.