opus - Jun 2020 - Add CMake build instructions to README

Hi,

Here is a patch to add build instructions for CMake to the README.

  *   I tried to follow the previous automake style instructions as closely as
possible but added instructions for Windows.
  *   Noted that it is still experimental

//Marcus
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.xiph.org/pipermail/opus/attachments/20200613/e9f742b6/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Add-build-instructions-for-CMake.patch
Type: application/octet-stream
Size: 1961 bytes
Desc: 0001-Add-build-instructions-for-CMake.patch
URL:
<http://lists.xiph.org/pipermail/opus/attachments/20200613/e9f742b6/attachment.obj>

On Sat, Jun 13, 2020 at 2:59 PM Marcus Asteborg <xnorpx at outlook.com>
wrote:
>
> Hi,
>
> Here is a patch to add build instructions for CMake to the README.
>
> I tried to follow the previous automake style instructions as closely as
possible but added instructions for Windows.
> Noted that it is still experimental
>
> //Marcus

Hi Marcus,

Currently the build instructions start with simple instructions for
building from the release tarball, and then provide more complex
alternative instructions that can be followed for those that need to
build the latest development code from git.  This adds instructions
for building with CMake, but not from the normal release tarball as
expected; instead the CMake instructions are a variation of the
alternative instructions for building from git.

If there is a reason that CMake should only be used with git then that
should be explained in the instructions; otherwise I would expect the
instructions to apply to the normal release tarball.  It's not clear
whether there is also a need for a fourth set of build instructions
for using CMake in combination with git, unless there is something
particularly notable about that combination.  Perhaps that might be
covered just for Windows, as an addendum to the existing git
instructions, since the existing git instructions specifically cover
several platforms, but not Windows.

 - Mark

________________________________
From: Mark Harris <mark.hsj at gmail.com>
Sent: Wednesday, June 24, 2020 00:09
To: Marcus Asteborg <xnorpx at outlook.com>
Cc: opus at xiph.org <opus at xiph.org>
Subject: Re: Add CMake build instructions to README
> Hi Marcus,
> Currently the build instructions start with simple instructions for
> building from the release tarball, and then provide more complex
> alternative instructions that can be followed for those that need to
> build the latest development code from git.  This adds instructions
> for building with CMake, but not from the normal release tarball as
> expected; instead the CMake instructions are a variation of the
> alternative instructions for building from git.
> If there is a reason that CMake should only be used with git then that
> should be explained in the instructions; otherwise I would expect the
> instructions to apply to the normal release tarball.  It's not clear
> whether there is also a need for a fourth set of build instructions
> for using CMake in combination with git, unless there is something
> particularly notable about that combination.  Perhaps that might be
> covered just for Windows, as an addendum to the existing git
> instructions, since the existing git instructions specifically cover
> several platforms, but not Windows.
> - Mark
Hi Mark,

CMake works fine to build from release tarball and git.
One do need to install compiler + cmake to configure and build.
The only reason I added it to the git instructions was that CMake is a clear
dependency
that needs to be installed on the system.

---------------

To build from a distribution tarball, you only need to do the following:

    % ./configure
    % make

To build from the git repository, the following steps are necessary:

-------------


I am not so familiar with automake and nix systems.

Does the configure install make and compilers that is needed for the make step?

Or is it assumed that the nix system already has it installed?


I like the idea to strip down to just use windows as CMake example.

Se let me iterate on the instructions and strip it down for Windows only.


//Marcus

..

-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.xiph.org/pipermail/opus/attachments/20200624/3b9eb011/attachment.html>

>>> Marcus Asteborg <xnorpx at outlook.com> schrieb am 24.06.2020
um 19:59 in
Nachricht
<8175_1593021574_5EF39486_8175_1287_1_DB3PR0602MB378816E9B5FC531496C4CE9FDF950
at D
3PR0602MB3788.eurprd06.prod.outlook.com>:
> 
> ________________________________
> From: Mark Harris <mark.hsj at gmail.com>
> Sent: Wednesday, June 24, 2020 00:09
> To: Marcus Asteborg <xnorpx at outlook.com>
> Cc: opus at xiph.org <opus at xiph.org>
> Subject: Re: Add CMake build instructions to README
> 
>> Hi Marcus,
> 
>> Currently the build instructions start with simple instructions for
>> building from the release tarball, and then provide more complex
>> alternative instructions that can be followed for those that need to
>> build the latest development code from git.  This adds instructions
>> for building with CMake, but not from the normal release tarball as
>> expected; instead the CMake instructions are a variation of the
>> alternative instructions for building from git.
> 
>> If there is a reason that CMake should only be used with git then that
>> should be explained in the instructions; otherwise I would expect the
>> instructions to apply to the normal release tarball.  It's not
clear
>> whether there is also a need for a fourth set of build instructions
>> for using CMake in combination with git, unless there is something
>> particularly notable about that combination.  Perhaps that might be
>> covered just for Windows, as an addendum to the existing git
>> instructions, since the existing git instructions specifically cover
>> several platforms, but not Windows.
> 
>> ‑ Mark
> 
> Hi Mark,
> 
> CMake works fine to build from release tarball and git.
> One do need to install compiler + cmake to configure and build.
> The only reason I added it to the git instructions was that CMake is a
clear
> dependency
> that needs to be installed on the system.
> 
> ‑‑‑‑‑‑‑‑‑‑‑‑‑‑‑
> 
> To build from a distribution tarball, you only need to do the following:
> 
>     % ./configure
>     % make
> 
> To build from the git repository, the following steps are necessary:
> 
> ‑‑‑‑‑‑‑‑‑‑‑‑‑
> 
> 
> I am not so familiar with automake and nix systems.
> 
> Does the configure install make and compilers that is needed for the make 
> step?
configure only configures the software for build, not the OS ;-)
However there are systems that automatically install a build environment
(naturally before calling configure)
> 
> Or is it assumed that the nix system already has it installed?
Probably the README informally states what is needed for building. For RPM
packages BuildRequires can state the requirements more formally (like having
specific mimimum versions of compiler, tools and libraries).
> 
> 
> I like the idea to strip down to just use windows as CMake example.
> 
> Se let me iterate on the instructions and strip it down for Windows only.
> 
> 
> //Marcus
> 
> ..