Re: [Notion-devel] [PATCH] add notes about getting and updating the source to README

[Arnout E. <no...@bz...>]

Merged thanks!

On Thu, Jul 12, 2012 at 12:13:48AM +0200, Matthias Lederhofer wrote:
> I struggled a bit to update to the latest version of notion because
> new submodules were added.  The natural place to look first was the
> README file, which didn't tell anything about this problem, except for
> the wiki link.  I think it would be nice to have a note about this in
> the README.
> 
> ---
>  README |   18 ++++++++++++------
>  1 file changed, 12 insertions(+), 6 deletions(-)
> 
> diff --git a/README b/README
> index 443579a..06209aa 100644
> --- a/README
> +++ b/README
> @@ -15,7 +15,13 @@ See also:
>  
>    https://sourceforge.net/apps/mediawiki/notion/index.php?title=Development
>  
> -1. Make sure you have the following tools and libraries installed (along
> +1. Get the source code.  Make sure all submodules are present and up to date.
> +    git clone git://notion.git.sourceforge.net/gitroot/notion/notion
> +    cd notion
> +    git submodule init
> +    git submodule update
> +
> +2. Make sure you have the following tools and libraries installed (along
>     with, of course, standard X11 and libc stuff).
>  
>      * GNU make <http://www.gnu.org/software/make/>
> @@ -30,24 +36,24 @@ See also:
>     If you also build the RandR and Xinerama modules, you will need:
>       libxinerama-dev libxrandr-dev
>  
> -2. Edit `system.mk` to suit your system. In particular, if you're on Ubuntu
> +3. Edit `system.mk` to suit your system. In particular, if you're on Ubuntu
>       or Debian, you'll need to uncomment the other set of LUA* variables.
>  
> -3. If you want to build some extra modules now or do not want to build
> +4. If you want to build some extra modules now or do not want to build
>     some of the standard modules, edit `modulelist.mk`.
>     
> -4. Run `make`. Note that `make` here refers to GNU make which is usually
> +5. Run `make`. Note that `make` here refers to GNU make which is usually
>     named `gmake` on systems with some other implementation of make as 
>     default.
>     
> -5. Run `make install`, as root if you set `$PREFIX` in `system.mk` to a 
> +6. Run `make install`, as root if you set `$PREFIX` in `system.mk` to a 
>     directory that requires those privileges.
>     
>     YOU SHOULD NOT SKIP THIS STEP unless you know what you are doing. Notion
>     will refuse to start if it can not find all the necessary uncorrupt
>     configuration files either in `$PREFIX/etc/notion/` or in `~/.notion/`.
>  
> -6. How to best set up `startx` or whatever to start Notion instead of your
> +7. How to best set up `startx` or whatever to start Notion instead of your
>     current window manager depends on your system's setup. A good guess
>     is creating or modifying an executable shell script `.xsession` in your
>     home directory to start Notion. This should usually (but not always) work
> -- 
> 1.7.10.4
> 
> 
> ------------------------------------------------------------------------------
> Live Security Virtual Conference
> Exclusive live event will cover all the ways today's security and 
> threat landscape has changed and how IT managers can respond. Discussions 
> will include endpoint security, mobile security and the latest in malware 
> threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
> _______________________________________________
> Notion-devel mailing list
> Not...@li...
> https://lists.sourceforge.net/lists/listinfo/notion-devel