Merge lp:~andrewsomething/ubuntu-packaging-guide/789975 into lp:ubuntu-packaging-guide

Proposed by Andrew Starr-Bochicchio
Status: Merged
Merged at revision: 99
Proposed branch: lp:~andrewsomething/ubuntu-packaging-guide/789975
Merge into: lp:ubuntu-packaging-guide
Diff against target: 54 lines (+50/-0)
1 file modified
README (+50/-0)
To merge this branch: bzr merge lp:~andrewsomething/ubuntu-packaging-guide/789975
Reviewer Review Type Date Requested Status
Daniel Holbach (community) Approve
Review via email: mp+105546@code.launchpad.net

Description of the change

Add a README file.

To post a comment you must log in.
Revision history for this message
Daniel Holbach (dholbach) wrote :

Great work! Thanks a lot! :)

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added file 'README'
2--- README 1970-01-01 00:00:00 +0000
3+++ README 2012-05-12 02:09:18 +0000
4@@ -0,0 +1,50 @@
5+The Ubuntu Packaging Guide
6+--------------------------
7+
8+This guide is often one of the first things that a new Ubuntu contributor will
9+look at. Helping make it better can have a big impact.
10+
11+It is split up into two sections:
12+
13+- A list of articles based on tasks, things you want to get done.
14+- A set of knowledge-base articles that dig deeper into specific bits of our
15+ tools and workflows.
16+
17+The actual articles can be found under the 'ubuntu-packaging-guide' directory
18+in rst files. The html template and css can be found under 'themes/ubuntu'. If
19+adding a new article, make sure to add it to the 'ubuntu-packaging-guide/index.rst'
20+file so that it appears in the table of contents.
21+
22+Development is hosted on Launchpad:
23+
24+Bugs - https://bugs.launchpad.net/ubuntu-packaging-guide/
25+Bzr Branch - lp:ubuntu-packaging-guide
26+Translations -https://translations.launchpad.net/ubuntu-packaging-guide
27+
28+This project is licensed under the CC-BY-SA-3.0, the full text of which can be
29+found in COPYING. Further information cand be found in 'debian/copyright'.
30+
31+
32+Sphinx & ReStructured text
33+--------------------------
34+
35+The guide is built using Sphinx (http://sphinx.pocoo.org/). Articles should be
36+written in ReStructured text. The following links might be helpful:
37+
38+http://docutils.sourceforge.net/docs/user/rst/quickstart.html
39+http://docutils.sourceforge.net/docs/user/rst/quickref.html
40+
41+
42+Building
43+--------
44+
45+The power of Sphinx is that it can generate documentation in many formats.
46+Running 'make all' will generate the guide in html, dirhtml, singlehtml, pickle,
47+json, htmlhelp, qthelp, devhelp, epub, latex, latexpdf, text, and man formats.
48+They will be outputted to the '_build' directory.
49+
50+Not all of these formats are important to us. You can build an individual
51+format with, for example, 'make html'. Run 'make help' for a list of all
52+targets.
53+
54+Please at least test your fixes by building the html version.

Subscribers

People subscribed via source and target branches