Re: [Inkscape-devel] URGENT: Please update Mac OS X install instructions in the tarball !
On 30/11/09 13:24, Wolf Drechsel wrote:
I am very grateful that a lot of people invested lots of time in the wonderful packaging/macosx/osx-build.sh script.
PLEASE, add a few lines to the READMEs - or create a distinguished "README_Mac_OS_X" to make clear, that the install procedure on a Mac is a different one.
Could you propose what should be added to the README. I think it's a good idea to update it, but I'm afraid that I would write something incorrect if I tried as I have no experience on OSX.
I'll be happy to give it a try - could friend ~suv have a look on it in order to avoid greater portions of nonsense please ?
I am not very comfortable with the proposed changes by Wolf:
a) README why only adding hints for OS X users? There are other platforms with special build tools (e.g. btool for win32) and - judging from the list of wiki pages about compilation on different linux platforms - deviations/adaptations from the generic 'configure/make/make install' routine are more common and not limited to Mac OS X.
b) INSTALL again - why adding only one of the sub-pages from the wiki which is already linked from the top wiki page about compilation and not the others as well? Personally I'd keep it as it is. If you need more information, the instructions are clear: read the wiki pages.
Alternative proposal 1) In the README file add a section to or after the description of the generic installation, mentioning the wiki pages for more information about platform specific issues.
2) In 'packaging/macosx' and 'packaging/win32' add new README files containing either a summary or a copy of the platform specific wiki page about building and packaging.
OTOH a 'packaging/macosx/README' could be as short as 1) please read the wiki page about compiling Inkscape on OS X: http://wiki.inkscape.org/wiki/index.php/CompilingMacOsX 2) consider additional information about MacPorts installation: http://www.macports.org/install.php using MacPorts: http://guide.macports.org/#using 3) run './osx-build.sh help' for an overview of the options available to configure, build and package Inkscape on OS X
~suv
appending fullquote since Wolf's mail didn't make it to the list:
I am very grateful that a lot of people invested lots of time in the wonderful packaging/macosx/osx-build.sh script.
PLEASE, add a few lines to the READMEs - or create a distinguished "README_Mac_OS_X" to make clear, that the install procedure on a Mac is a different one.
Could you propose what should be added to the README. I think it's a good idea to update it, but I'm afraid that I would write something incorrect if I tried as I have no experience on OSX.
I'll be happy to give it a try - could friend ~suv have a look on it in order to avoid greater portions of nonsense please ?
I suggest to change this chapter of the README:
Inkscape uses the standard procedure for compilation and installation:
./configure make make install
If a "./configure" file is not present, you can create it by running the "./autogen.sh" command, which calls in turn a number of other programs such as automake and autoconf. See INSTALL for more details.
into:
++++++++++++++++++++++++++++++++++++++++++++++++++++ Installation for *nixes (Mac OS X users please have a look at the end of the file): ==========================================================
Inkscape uses the standard procedure for compilation and installation:
./configure make make install
If a "./configure" file is not present, you can create it by running the "./autogen.sh" command, which calls in turn a number of other programs such as automake and autoconf. See INSTALL for more details. ++++++++++++++++++++++++++++++++++++++++++++++++++++
At end of file: ++++++++++++++++++++++++++++++++++++++++++++++++++++ Installation for Mac OS X users =======================
We try to keep the Wiki pages on compiling inkscape up-to-date and comprehensive. It is here:
http://wiki.inkscape.org/wiki/index.php/CompilingMacOsX
For a brief overlook: We suggest to use macports (http://macports.org) in order to achieve all the necessary components and libraries. Than there is a mighty tool called "osx-build.sh" in the packaging/macosx directory of the unpacked tarball. This script will do most of the work for you. ++++++++++++++++++++++++++++++++++++++++++++++++++++
In the INSTALL file change:
Basic Installation
If you have problems compiling Inkscape, then see http://wiki.inkscape.org/wiki/index.php/CompilingInkscape .
The remainder of this file gives generic installation instructions.
into
Basic Installation for *nixes - Mac OS X users please have a look at the README
If you have problems compiling Inkscape, then see http://wiki.inkscape.org/wiki/index.php/CompilingInkscape
if you are a Mac OS X user, please dont read on, keep to the wiki pages instead: http://wiki.inkscape.org/wiki/index.php/CompilingMacOsX
The remainder of this file gives generic installation instructions. …
On Mon, Nov 30, 2009 at 12:03 PM, ~suv <suv-sf@...58...> wrote:
- In 'packaging/macosx' and 'packaging/win32' add new README files
containing either a summary or a copy of the platform specific wiki page about building and packaging.
I've often seen files like 'README.win32', 'README.osx' in the main dir - those would be easier to find (I don't know that I would think to check the packaging dir before compiling on a platform other than linux).
Just an idea...
Chris
On 30/11/09 19:10, Chris Mohler wrote:
On Mon, Nov 30, 2009 at 12:03 PM, ~suv <suv-sf@...58...> wrote:
- In 'packaging/macosx' and 'packaging/win32' add new README files
containing either a summary or a copy of the platform specific wiki page about building and packaging.
I've often seen files like 'README.win32', 'README.osx' in the main dir - those would be easier to find (I don't know that I would think to check the packaging dir before compiling on a platform other than linux).
Just an idea...
Agreed, seems way better than 'hiding' them in the packaging subdirs ;-)
~suv
https://code.launchpad.net/~inkscape.dev/inkscape/readme-update/+merge/15433
I updated the branch, and the diff has been updated on the merge request. What do you guys think about this diff?
--Ted
On Mon, Nov 30, 2009 at 11:54 PM, Ted Gould <ted@...11...> wrote:
https://code.launchpad.net/~inkscape.dev/inkscape/readme-update/+merge/15433
I updated the branch, and the diff has been updated on the merge request. What do you guys think about this diff?
Looks good to me, except "Than" should be "Then" in the readme.
On Tue, Dec 1, 2009 at 04:54, Ted Gould <ted@...11...> wrote:
https://code.launchpad.net/~inkscape.dev/inkscape/readme-update/+merge/15433
I updated the branch, and the diff has been updated on the merge request. What do you guys think about this diff?
First a technical point: is creating a branch for changes such as this the preferred way to go? Are there instructions about what namespace one should use (inkscape-dev, own name etc.)? Inkscape wiki regarding bazaar is basically about reproducing svn's workflow. I would rather have a workflow with local commits + push to lp:inkscape than immediate commits to a remote personal branch + merge to lp:inkscape.
Second, the README seems to be intended to hold general information about Inkscape, which is translated, while INSTALL contains more details about the technical part of the installation. Why not move the general instructions ./configure make make install to INSTALL, extend it and keep all that in english only since contributors to Inkscape are likely to need to speek english anyway? Then the specific build instructions could be: - either move entirely to the wiki: simplify the current INSTALL to make it as basic as possible and add a link - or moved entirely to INSTALL (possibly to INSTALL.fedora, INSTALL.win32, INSTALL.macosx, etc.) I would personally be for un-cluttering the wiki and allow the instructions to move under version control at the same pace as the code.
JiHO --- http://maururu.net
On Mon, Dec 7, 2009 at 03:14, JiHO <jo.lists@...400...> wrote:
Inkscape wiki regarding bazaar is basically about reproducing svn's workflow. I would rather have a workflow with local commits + push to lp:inkscape than immediate commits to a remote personal branch + merge to lp:inkscape.
I updated the wiki page: http://wiki.inkscape.org/wiki/index.php/Working_with_Bazaar with a few things about different workflows. It needs checking since I am a bazaar newbie but it looks like I have found the kind of workflow I like and am used to in git.
JiHO --- http://maururu.net
I am not very comfortable with the proposed changes by Wolf:
a) README why only adding hints for OS X users?
IMHO other platforms are very welcome to provide brief notes on their compiling specialities. Nevertheless, as Mac OS X is a Unix derivate, I feel the special need for a hint for Maccies - as they otherwise (like happened to me) expect the ordinary *nix procedure to work.
There are other platforms with special build tools (e.g. btool for win32) and - judging from the list of wiki pages about compilation on different linux platforms - deviations/adaptations from the generic 'configure/make/make install' routine are more common and not limited to Mac OS X.
b) INSTALL again - why adding only one of the sub-pages from the wiki which is already linked from the top wiki page about compilation and not the others as well? Personally I'd keep it as it is. If you need more information, the instructions are clear: read the wiki pages.
Alternative proposal
- In the README file add a section to or after the description of the
generic installation, mentioning the wiki pages for more information about platform specific issues.
Allright - but please give a clear hint, that on Mac OS X configure - make - make install is not the best option to begin with.
- In 'packaging/macosx' and 'packaging/win32' add new README files
containing either a summary or a copy of the platform specific wiki page about building and packaging.
OTOH a 'packaging/macosx/README' could be as short as
- please read the wiki page about compiling Inkscape on OS X: http://wiki.inkscape.org/wiki/index.php/CompilingMacOsX
- consider additional information about MacPorts installation: http://www.macports.org/install.php using MacPorts: http://guide.macports.org/#using
- run './osx-build.sh help' for an overview of the options available to configure, build and package Inkscape on OS X
But in this case there should be a very clear pointer to the packacking/macosx/README
Greetings,
Wolf
participants (6)
-
bulia byak -
Chris Mohler -
JiHO -
Ted Gould -
Wolf Drechsel -
~suv