Merge lp:~sladen/unity/unity-3d-hacking-docs into lp:unity

[Paul Sladen]

HACKING: update documentation with working TL;DR at the top and downcase 'cmake' commandline examples so that they also work.

[Thomi Richards (thomir-deactivatedaccount)]

I'm not sure we should be advising people to install unity built locally into their system folders! A much safer alternative would be to include instructions to install it into a staging directory in their home folder, but that makes the instructions much longer.

[Tim Penhey (thumper)]

Paul, I agree with Thomi. We shouldn't give any default instructions that require sudo to install.

review: Needs Fixing

[Paul Sladen (sladen)]

If somebody from DX can a working preferred/best practice method I'll be happy to use that, in-lieu of the current.

(IIRC, there was an issue that the assets from the build directory were not picked up).

[Mikkel Kamstrup Erlandsen (kamstrup)]

I'll never let a chance to pimp unity-jhbuild slip! :-)

Can we stick a pointer to lp:unity-jhbuild in there for enterprising hackers that want to build the entire unity (2d/3d) stack and have it running out of their home dirs. Please :-)

There are scarily many pitfalls in running custom unities (one easily ends up with broken session when installing into ~/.compiz-1). unity-jhbuild has been carefully crafted to always be reversible by a simple 'rm -rf ~/unity'.

[Sebastien Bacher (seb128)]

yeah, please no instruction to install to /usr/local/something, that keeps bitting people including dx members since those take over the distro version

[Mikkel Kamstrup Erlandsen (kamstrup)]

/me takes this as an official endorsement of unity-jhbuild from seb128

[Paul Sladen (sladen)]

seb128; kamstrup: could one of you give a five-line idiots guide for using the preferred 'unity-jhbuild' method and I'll rework the HACKING patch to recommend that method.

As noted before I'm happy to document any method that DX prefer, all of which would be more preferable than the current non-working 'HACKING' documentation that is shipped.

[Mikkel Kamstrup Erlandsen (kamstrup)]

The condensed unity-jhbuild guide is:

bzr branch lp:unity-jhbuild ~/unity
less ~/unity/README

(and yes, it must be ~/unity exactly, not somewhere else)

:-)

Unmerged revisions

2019. By Paul Sladen on 2012-02-24

HACKING: downcase 'cmake' command-line examples so they work

2018. By Paul Sladen on 2012-02-24

HACKING: TL;DR section with instructions that actually work

=== modified file 'HACKING'
--- HACKING	2012-02-04 05:28:23 +0000
+++ HACKING	2012-02-24 16:27:18 +0000
@@ -1,3 +1,14 @@
+TL;DR:
+
+  sudo apt-get build-dep unity
+  mkdir unity/build && cd unity/build
+  cmake ..
+
+  make -j4
+  sudo make install
+  /usr/local/bin/unity --reset
+
+
 If you want to hack on unity you need the following packages
   - nux
   - libbamf
@@ -23,11 +34,11 @@
   bzr branch lp:unity
 
 then make a directory called build in unity directory. inside that directory run
-  CMAKE ../
+  cmake ../
   make
 
 Please note that this will create a systemwide install of unity, if you are developing localy (you are unless you know different) run 
-  CMAKE -DCMAKE_INSTALL_PREFIX=~/staging ../
+  cmake -DCMAKE_INSTALL_PREFIX=~/staging ../
 
 changing ~/staging to suit wherever you want to install files locally