Skip to content

Commit

Permalink
More fixes for merge of install and coding docs. Added generated pdfs…
Browse files Browse the repository at this point in the history 
… to git
  • Loading branch information
@timlinux
timlinux committed May 26, 2011
1 parent c9c530f commit 7763ef7
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 167 deletions.
Binary file added CODING.pdf
View file
Binary file not shown.
73 changes: 5 additions & 68 deletions INSTALL
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Quantum GIS (QGIS)
Building QGIS from source - step by step
Thursday May 26, 2011


Last update: 20110526
Last change: 20110526
Last Updated: Thursday May 26, 2011
Last Change : Thursday May 26, 2011


1. Introduction
Expand All @@ -29,10 +30,7 @@ Last change: 20110526
5.4. QGIS source
5.5. Configure the build
5.6. Building
6. git
6.1. Installation
6.2. Get QGIS from git
7. Authors and Acknowledgments
6. Authors and Acknowledgments


1. Introduction
Expand Down Expand Up @@ -1583,68 +1581,7 @@ or, for an /Applications build:
sudo make install


6. git
======


6.1. Installation
=================

Optional. If you want to try different branches and/or easily update the source when changes are made, install git and clone the source. For random just-want-to-see-what's-going-on-in-development builds, download a tarbal from github.


6.1.1. Install git for GNU/Linux
================================


6.1.2. install git for Windows
==============================


6.1.3. Install git for OSX
==========================

The git (http://git-scm.com/) project has a downloadable build of git.
Make sure to get the package matching your processor (x86_64 most likely, only the first Intel Macs need the i386 package).

Once downloaded open the disk image and run the installer.

PPC/source note

The git site does not offer PPC builds. If you need a PPC build, or you just want
a little more control over the installation, you need to compile it yourself.

Download the source from http://git-scm.com/. Unzip it, and in a Terminal cd to the source folder, then:

make prefix=/usr/local
sudo make prefix=/usr/local install

If you don't need any of the extras, Perl, Python or TclTk (GUI), you can disable them before running make with:

export NO_PERL=
export NO_TCLTK=
export NO_PYTHON=


6.2. Get QGIS from git
======================

You can download a development tarball (no git installation needed) from:

http://github.com/qgis/Quantum-GIS

This defaults to the current master, but you can select any other branch or tag as desired.

Or for more long-term testing of development sources: clone the sources with git (in an appropriate location on your computer):

git clone git://github.com/qgis/Quantum-GIS.git

This automatically activates the master. To switch to another branch:

git checkout [branchname]


7. Authors and Acknowledgments
6. Authors and Acknowledgments
==============================

The following people have contributed to this document:
Expand Down
Binary file added INSTALL.pdf
View file
Binary file not shown.
36 changes: 32 additions & 4 deletions doc/CODING.t2t
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,37 @@ Developers guide for QGIS
%! PostProc(txt): '(?i)(\t)' ' '
%! encoding: iso-8859-1

%
% Tex processing
%
% Make sure this is first
%! PostProc(tex): '\\includegraphics' '\\includegraphics[width=100mm]'
% scartcl is from the koma script document class (apt-get install texlive-latex-recommended ttf-komatuna)
% setlength parindent suppresses first line of paragraph idents
% parskip puts blank space between paragraphs
% title pic stuff used to put a logo on the front page
%! PostProc(tex): '\\documentclass{article}' '\\documentclass{scrartcl}\n\\setlength{\\parindent}{0pt}\n\\setlength{\\parskip}{2ex}'
% use the color table and table packages so we can pimp the tables a little
%! PostProc(tex): '\\usepackage{style.css} % user defined' '\\usepackage{fancyvrb}\n\\usepackage{colortbl} \n\\usepackage [table]{xcolor}\n\\definecolor{tableShade}{HTML}{cecece}\n\\definecolor{qgis-green}{HTML}{0E7300}\n\\usepackage{wallpaper}\n\\LRCornerWallPaper{1}{WALLPAPER-IMAGE}\n\\usepackage{hyperref}\n\\hypersetup{linkcolor=qgis-green,urlcolor=qgis-green}\\renewcommand\\thesection{\\color{qgis-green}\\thechapter\\arabic{section}}'
% Make the header row of tables have a dark background. light text
%! PostProc(tex): '\\hline \\textbf' '\\hline \\rowcolor[rgb]{0,0,0} \\color{white} \\textbf'
%! PostProc(tex): '& \\textbf' '& \\color{white} \\textbf'
% Make verbatim text a little smaller and use fancyvrb package to draw it in a box
% Note Verbatim with capital V for fancyvrb to work
%! PostProc(tex): '\\begin{verbatim}' '{\\scriptsize\\begin{Verbatim}[frame=single,rulecolor=\\color{qgis-green}, framesep=4mm, label=\\fbox{\\small\\emph{Listing}}]'
%! PostProc(tex): '\\end{verbatim}' '\\end{Verbatim}\n}'
%! PostProc(tex): '\\section' '\\newpage\\section'
%! PostProc(tex): 'section{' 'section{\\color{qgis-green}'
%! PostProc(tex): NEWPAGE '\\newpage'
% Give alternating table rows different colours and use a smaller font in tables (\tiny)
%! PostProc(tex): '\\begin{tabular}' '\\rowcolors{2}{tableShade}{white} \n\\tiny\\begin{tabular}'
%! encoding: iso-8859-1

%! PostProc(tex): WALLPAPER-IMAGE 'qgis-footer.png'
% These are comments and will not be generated in any output
% -------------------

%This document is in text2tags format. You can generate html, plain text and
%This document is in txt2tags format. You can generate html, plain text and
%moinmoin formatted documentation by running txt2tags on this document. See the
%txt2tags home page for more details. Please insert manual line breaks in this
%document as it makes diffing for changes much easier. To do this in vim
Expand All @@ -26,12 +52,13 @@ Developers guide for QGIS

% To generate the text version of this document:
% txt2tags -t txt -o CODING CODING.t2t
% To generate the moinmoin version of this document:
% txt2tags -t moin -o CODING.moin CODING.t2t
% To generate the mediawiki version of this document:
% txt2tags -t wiki --no-enum-title -o CODING.wiki CODING.t2t
% To generate the html version of this document:
% txt2tags -t html -o CODING.html CODING.t2t
% To generate the LaTeX version of this document:
% txt2tags -t tex -o CODING.tex CODING.t2t
% txt2tags -t tex -o CODING.tex CODING.t2t; pdflatex CODING.tex

%
% End of comments
% -------------------
Expand Down Expand Up @@ -389,6 +416,7 @@ sudo apt-get install git
Windows users can obtain [msys git http://code.google.com/p/msysgit/].



== Accessing the Repository ==

To clone QGIS master:
Expand Down
95 changes: 7 additions & 88 deletions doc/INSTALL.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,14 @@

<DIV CLASS="header" ID="header">
<H1>Quantum GIS (QGIS)</H1>
<H3>Building QGIS from source - step by step</H3>
<H2>Building QGIS from source - step by step</H2>
<H3>Thursday May 26, 2011</H3>
</DIV>

<DIV CLASS="body" ID="body">
<P>
Last update: 20110526
Last change: 20110526
Last Updated: Thursday May 26, 2011
Last Change : Thursday May 26, 2011
</P>
<DIV CLASS="toc">

Expand Down Expand Up @@ -84,12 +85,7 @@ <H3>Building QGIS from source - step by step</H3>
<LI><A HREF="#toc22">5.5. Configure the build</A>
<LI><A HREF="#toc23">5.6. Building</A>
</UL>
<LI><A HREF="#git">git</A>
<UL>
<LI><A HREF="#toc25">6.1. Installation</A>
<LI><A HREF="#toc26">6.2. Get QGIS from git</A>
</UL>
<LI><A HREF="#toc27">Authors and Acknowledgments</A>
<LI><A HREF="#toc24">Authors and Acknowledgments</A>
</OL>

</DIV>
Expand Down Expand Up @@ -2217,85 +2213,8 @@ <H2>5.6. Building</H2>
sudo make install
</PRE></div>

<A NAME="git"></A>
<H1>6. git</H1>

<A NAME="toc25"></A>
<H2>6.1. Installation</H2>

<P>
Optional. If you want to try different branches and/or easily update the source when changes are made, install git and clone the source. For random just-want-to-see-what's-going-on-in-development builds, download a tarbal from github.
</P>

<H3>6.1.1. Install git for GNU/Linux</H3>

<H3>6.1.2. install git for Windows</H3>

<H3>6.1.3. Install git for OSX</H3>

<P>
The <A HREF="http://git-scm.com/">git</A> project has a downloadable build of git.
Make sure to get the package matching your processor (x86_64 most likely, only the first Intel Macs need the i386 package).
</P>
<P>
Once downloaded open the disk image and run the installer.
</P>
<P>
<U>PPC/source note</U>
</P>
<P>
The git site does not offer PPC builds. If you need a PPC build, or you just want
a little more control over the installation, you need to compile it yourself.
</P>
<P>
Download the source from <A HREF="http://git-scm.com/">http://git-scm.com/</A>. Unzip it, and in a Terminal cd to the source folder, then:
</P>

<div class="code"><PRE>
make prefix=/usr/local
sudo make prefix=/usr/local install
</PRE></div>

<P>
If you don't need any of the extras, Perl, Python or TclTk (GUI), you can disable them before running make with:
</P>

<div class="code"><PRE>
export NO_PERL=
export NO_TCLTK=
export NO_PYTHON=
</PRE></div>

<A NAME="toc26"></A>
<H2>6.2. Get QGIS from git</H2>

<P>
You can download a development tarball (no git installation needed) from:
</P>
<P>
<A HREF="http://github.com/qgis/Quantum-GIS">http://github.com/qgis/Quantum-GIS</A>
</P>
<P>
This defaults to the current master, but you can select any other branch or tag as desired.
</P>
<P>
Or for more long-term testing of development sources: clone the sources with git (in an appropriate location on your computer):
</P>

<div class="code"><PRE>
git clone git://github.com/qgis/Quantum-GIS.git
</PRE></div>

<P>
This automatically activates the master. To switch to another branch:
</P>

<div class="code"><PRE>
git checkout [branchname]
</PRE></div>

<A NAME="toc27"></A>
<H1>7. Authors and Acknowledgments</H1>
<A NAME="toc24"></A>
<H1>6. Authors and Acknowledgments</H1>

<P>
The following people have contributed to this document:
Expand Down
38 changes: 31 additions & 7 deletions doc/INSTALL.t2t
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Quantum GIS (QGIS)

Building QGIS from source - step by step

%%date(%A %B %d, %Y)

%! target : html
%! style : style.css
Expand All @@ -12,6 +11,33 @@ Building QGIS from source - step by step
% Next line will replace tabs with 2 spaces in txt generated outputs
%! PostProc(txt): '(?i)(\t)' ' '
%! encoding: iso-8859-1
%
% Tex processing
%
% Make sure this is first
%! PostProc(tex): '\\includegraphics' '\\includegraphics[width=100mm]'
% scartcl is from the koma script document class (apt-get install texlive-latex-recommended ttf-komatuna)
% setlength parindent suppresses first line of paragraph idents
% parskip puts blank space between paragraphs
% title pic stuff used to put a logo on the front page
%! PostProc(tex): '\\documentclass{article}' '\\documentclass{scrartcl}\n\\setlength{\\parindent}{0pt}\n\\setlength{\\parskip}{2ex}'
% use the color table and table packages so we can pimp the tables a little
%! PostProc(tex): '\\usepackage{style.css} % user defined' '\\usepackage{fancyvrb}\n\\usepackage{colortbl} \n\\usepackage [table]{xcolor}\n\\definecolor{tableShade}{HTML}{cecece}\n\\definecolor{qgis-green}{HTML}{0E7300}\n\\usepackage{wallpaper}\n\\LRCornerWallPaper{1}{WALLPAPER-IMAGE}\n\\usepackage{hyperref}\n\\hypersetup{linkcolor=qgis-green,urlcolor=qgis-green}\\renewcommand\\thesection{\\color{qgis-green}\\thechapter\\arabic{section}}'
% Make the header row of tables have a dark background. light text
%! PostProc(tex): '\\hline \\textbf' '\\hline \\rowcolor[rgb]{0,0,0} \\color{white} \\textbf'
%! PostProc(tex): '& \\textbf' '& \\color{white} \\textbf'
% Make verbatim text a little smaller and use fancyvrb package to draw it in a box
% Note Verbatim with capital V for fancyvrb to work
%! PostProc(tex): '\\begin{verbatim}' '{\\scriptsize\\begin{Verbatim}[frame=single,rulecolor=\\color{qgis-green}, framesep=4mm, label=\\fbox{\\small\\emph{Listing}}]'
%! PostProc(tex): '\\end{verbatim}' '\\end{Verbatim}\n}'
%! PostProc(tex): '\\section' '\\newpage\\section'
%! PostProc(tex): 'section{' 'section{\\color{qgis-green}'
%! PostProc(tex): NEWPAGE '\\newpage'
% Give alternating table rows different colours and use a smaller font in tables (\tiny)
%! PostProc(tex): '\\begin{tabular}' '\\rowcolors{2}{tableShade}{white} \n\\tiny\\begin{tabular}'
%! encoding: iso-8859-1

%! PostProc(tex): WALLPAPER-IMAGE 'qgis-footer.png'
% These are comments and will not be generated in any output
% -------------------

Expand All @@ -30,13 +56,13 @@ Building QGIS from source - step by step
% To generate the html version of this document:
% txt2tags -t html -o INSTALL.html INSTALL.t2t
% To generate the LaTeX version of this document:
% txt2tags -t tex -o INSTALL.tex INSTALL.t2t
% txt2tags -t tex -o INSTALL.tex INSTALL.t2t; pdflatex INSTALL.tex

% End of comments
% -------------------

Last update: %%date
Last change: %%mtime
Last Updated: %%date(%A %B %d, %Y)
Last Change : %%mtime(%A %B %d, %Y)

%%toc

Expand Down Expand Up @@ -86,6 +112,4 @@ source directory.

%!include: osx.t2t

%!include: git.t2t

%!include: iauthors.t2t
Binary file added doc/qgis-footer.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7763ef7

Please sign in to comment.