After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 763618 - README instruction is outdated
README instruction is outdated
Status: RESOLVED FIXED
Product: gnome-music
Classification: Applications
Component: user docs
unspecified
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Maintainers of Gnome user documentation
Depends on:
Blocks:
 
 
Reported: 2016-03-14 13:53 UTC by Chieh-Min Wang
Modified: 2016-04-04 14:54 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Updated README to instruct newcomers using jhbuild (708 bytes, patch)
2016-03-22 10:45 UTC, Chieh-Min Wang
none Details | Review
Updated README to instruct newcomers using jhbuild (677 bytes, patch)
2016-03-22 17:29 UTC, Chieh-Min Wang
none Details | Review
Instruct newcomers using jhbuild for building (1.00 KB, patch)
2016-03-28 06:31 UTC, Chieh-Min Wang
none Details | Review
Instruct newcomers using jhbuild for building (1.00 KB, text/plain)
2016-04-04 02:47 UTC, Chieh-Min Wang
  Details
Instruct newcomers using jhbuild for building gnome (1.02 KB, patch)
2016-04-04 02:58 UTC, Chieh-Min Wang
none Details | Review
Instruct newcomers using jhbuild for building gnome (1.01 KB, patch)
2016-04-04 13:09 UTC, Chieh-Min Wang
none Details | Review
Instruct newcomers using jhbuild for building gnome (1.01 KB, patch)
2016-04-04 14:30 UTC, Chieh-Min Wang
none Details | Review
Instruct newcomers using jhbuild for building gnome (1.01 KB, patch)
2016-04-04 14:31 UTC, Chieh-Min Wang
committed Details | Review

Description Chieh-Min Wang 2016-03-14 13:53:32 UTC
I followed the steps in the README to build gnome-music. However the README is outdated. The README should instruct the user to use jhbuild to build gnome-music.
Comment 1 Chieh-Min Wang 2016-03-22 10:45:27 UTC
Created attachment 324531 [details] [review]
Updated README to instruct newcomers using jhbuild

I changed the README to instruct newcomers using jhbuild for building GNOME Music. Hope this is appropriate.
Comment 2 Chieh-Min Wang 2016-03-22 17:29:13 UTC
Created attachment 324548 [details] [review]
Updated README to instruct newcomers using jhbuild
Comment 3 Chieh-Min Wang 2016-03-28 06:31:18 UTC
Created attachment 324863 [details] [review]
Instruct newcomers using jhbuild for building

Using git format-patch when generating patch.
Comment 4 Felipe Borges 2016-04-03 18:16:06 UTC
Review of attachment 324863 [details] [review]:

Thanks for the patch. needs-work.

::: README
@@ +20,3 @@
 https://wiki.gnome.org/Newcomers/BuildGnome
 
+After installing jhbuild, run "jhbuild build gnome-music" to build gnome-music and all its dependeicies.

You misspelled "dependencies".
Comment 5 Chieh-Min Wang 2016-04-04 02:47:53 UTC
Created attachment 325293 [details]
Instruct newcomers using jhbuild for building

Fixed the mispell
Comment 6 Chieh-Min Wang 2016-04-04 02:58:08 UTC
Created attachment 325299 [details] [review]
Instruct newcomers using jhbuild for building gnome

The last patch does not include all the changes.
Comment 7 Felipe Borges 2016-04-04 08:10:52 UTC
Review of attachment 325299 [details] [review]:

::: README
@@ +18,1 @@
+GNOME Music is best built with jhbuild. Please followed the BuildGnome tutorial for newcomers closely.

I would rather have something like "Follow the BuildGnome tutorial for newcomers at https://wiki.gnome.org/Newcomers/BuildGnome"

@@ +21,3 @@
+
+After installing jhbuild, run "jhbuild build gnome-music" to build gnome-music and all its dependencies.
+Finally, start gnome music with "jhbuild run gnome-music"

These steps could have been itemized. For instance:

After installing jhbuild, run:
$ jhbuild build gnome-music
...
Comment 8 Chieh-Min Wang 2016-04-04 13:09:16 UTC
Created attachment 325338 [details] [review]
Instruct newcomers using jhbuild for building gnome

* Itemized the steps for building and running gnome-music
* Change some sentences.
Comment 9 Felipe Borges 2016-04-04 14:26:16 UTC
Review of attachment 325338 [details] [review]:

::: README
@@ +20,1 @@
+After installing jhbuild, you have to build gnome-music and all its dependeicies. The task can be done by simply running:

dependencies.
Comment 10 Chieh-Min Wang 2016-04-04 14:30:34 UTC
Created attachment 325344 [details] [review]
Instruct newcomers using jhbuild for building gnome

Fixed the typo ><
Comment 11 Chieh-Min Wang 2016-04-04 14:31:46 UTC
Created attachment 325345 [details] [review]
Instruct newcomers using jhbuild for building gnome

Uploaded the updated version. sorry ><
Comment 12 Felipe Borges 2016-04-04 14:37:05 UTC
Review of attachment 325345 [details] [review]:

ok.
Comment 13 Felipe Borges 2016-04-04 14:38:57 UTC
Thanks for your patch.
Comment 14 Carlos Soriano 2016-04-04 14:54:38 UTC
Hey,
this instructions tend to be outdated fairly easy. I suggest to just link to https://wiki.gnome.org/Newcomers/BuildGnome as you did, but don't specify more steps.
Just my 2 cents :)