Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e24f05e

Browse files
committed
Improve Windows and Mac OS-specific instructions for running the
setup script. Also added a comment about how it *should* work on Mac OS.
1 parent 078fc08 commit e24f05e

1 file changed

Lines changed: 27 additions & 10 deletions

File tree

Doc/inst/inst.tex

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,8 @@ \section{Standard Build and Install}
168168
python setup.py install
169169
\end{verbatim}
170170
On Unix, you'd run this command from a shell prompt; on Windows, you
171-
have to open a command prompt window and do it there; on Mac~OS ...
172-
\XXX{what the heck do you do on Mac~OS?}.
171+
have to open a command prompt window (``DOS box'') and do it there; on
172+
Mac~OS, things are a tad more complicated (see below).
173173

174174

175175
\subsection{Platform variations}
@@ -185,18 +185,35 @@ \subsection{Platform variations}
185185
python setup.py install
186186
\end{verbatim}
187187

188-
On Windows, you'd probably unpack the archive before opening the command
189-
prompt. If you downloaded the archive file to
190-
\file{C:\textbackslash{}Temp}, then it probably unpacked (depending on
191-
your software) into
192-
\file{C:\textbackslash{}Temp\textbackslash{}foo-1.0}; from the command
193-
prompt window, you would then run
188+
On Windows, you'd probably download \file{foo-1.0.zip}. If you
189+
downloaded the archive file to \file{C:\textbackslash{}Temp}, then it
190+
would unpack into \file{C:\textbackslash{}Temp\textbackslash{}foo-1.0};
191+
you can use either a GUI archive manipulator (such as WinZip) or a
192+
command-line tool (such as \program{unzip} or \program{pkunzip}) to
193+
unpack the archive. Then, open a command prompt window (``DOS box''),
194+
and run:
194195
\begin{verbatim}
195-
cd c:\temp\foo-1.0
196+
cd c:\Temp\foo-1.0
196197
python setup.py install
197198
\end{verbatim}
198199

199-
On Mac~OS, ... \XXX{again, how do you run Python scripts on Mac~OS?}
200+
On Mac~OS, you have to go through a bit more effort to supply
201+
command-line arguments to the setup script:
202+
\begin{itemize}
203+
\item hit option-double-click on the script's icon (or option-drop it
204+
onto the Python interpreter's icon)
205+
\item press the ``Set unix-style command line'' button
206+
\item set the ``Keep stdio window open on termination'' if you're
207+
interested in seeing the output of the setup script (which is usually
208+
voluminous and often useful)
209+
\item (??) when the command-line dialog pops up, enter ``install'' (you
210+
can, of course, enter any Distutils command-line as described in this
211+
document or in the ``Distributing Python Modules'' document: just
212+
leave of the initial \code{python setup.py} and you'll be fine)
213+
\end{itemize}
214+
\XXX{this should change: every Distutils setup script will need
215+
command-line arguments for every run (and should probably keep stdout
216+
around), so all this should happen automatically for setup scripts}
200217

201218

202219
\subsection{Splitting the job up}

0 commit comments

Comments
 (0)