summaryrefslogtreecommitdiff
path: root/src/devel
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2018-02-23 22:11:00 -0600
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2018-04-26 22:06:38 -0500
commit4a60e9786aa1347bca162058afc62130356bcee6 (patch)
tree0bb981a643c19dc201990b1a3a1b9849244efaf1 /src/devel
parent846b87b954cb3ac8b81251d28deeb3cb5988d33c (diff)
downloaddocs-4a60e9786aa1347bca162058afc62130356bcee6.tar.gz
docs-4a60e9786aa1347bca162058afc62130356bcee6.tar.bz2
docs-4a60e9786aa1347bca162058afc62130356bcee6.tar.xz
docs-4a60e9786aa1347bca162058afc62130356bcee6.zip
Developer's Guide: Add some more docs
Diffstat (limited to 'src/devel')
-rw-r--r--src/devel/3_git.xml4
-rw-r--r--src/devel/4_hello.xml13
2 files changed, 13 insertions, 4 deletions
diff --git a/src/devel/3_git.xml b/src/devel/3_git.xml
index ed97eca..73e3522 100644
--- a/src/devel/3_git.xml
+++ b/src/devel/3_git.xml
@@ -34,7 +34,7 @@
<title>Learning More about Git</title>
<para>There are many helpful resources available for you to learn more about Git.
You may install the <package>git-doc</package> package on your Adélie computer for easy access to the built-in manuals.
- Additionally, if you have access to the World Wide Web, you may read the freely-licensed Pro Git book at https://git-scm.com/book/en/v2.
+ Additionally, if you have access to the World Wide Web, you may read the freely-licensed <ulink url="https://git-scm.com/book/en/v2"><citetitle pubwork="book">Pro Git</citetitle> book</ulink>.
There are also a number of mailing lists for starting out and working with Git.</para>
</section>
</section>
@@ -98,7 +98,7 @@ Acked-by: Developer Name &lt;email@adelielinux.org&gt;
For instance, if you "bump" or update the version of three packages, you would use one commit for each of the three packages, for a total of three commits.
This allows an Adélie Linux developer to review each package's change separately.
There are some reasons you may want a single commit to hold changes to multiple packages.
- For example, if you are updating the license fields of many packages, you may want a single commit with a message similar to <literal>main/libx*: update licenses on X11 libraries</literal>.</para>
+ For example, if you are updating the license fields of many packages, you may want a single commit with a message similar to <literal>main/libx*: Update licenses on X11 libraries</literal>.</para>
</section>
</section>
</chapter>
diff --git a/src/devel/4_hello.xml b/src/devel/4_hello.xml
index cc45af6..637e6d9 100644
--- a/src/devel/4_hello.xml
+++ b/src/devel/4_hello.xml
@@ -1,9 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter label="4" id="hello">
<title>Writing Your First Package</title>
- <para></para>
+ <para>Now that you have a complete development environment configured and know how to use Git, you're ready to start writing your first package recipe.
+ This chapter will introduce the <command>newapkbuild</command> command and the <filename>APKBUILD</filename> structure common to all packages.</para>
+ <section>
+ <title>Checking Out a Package Repository</title>
+ <para>As noted in chapter 1, all packages live in a <em>package repository</em>. Typically, package repositories are stored in Git. You can make your own package repository, but for now, we will use a <em>private fork</em> of the Adélie Linux official package repositories.</para>
+ <para><ulink url="https://code.foxkit.us/users/sign_in">Sign in</ulink> to the Adélie Linux Git system. If you have not yet created an account, you will need to sign up for one. The sign up form can be accessed from the sign in page.</para>
+ <para>Navigate to the <ulink url="https://code.foxkit.us/adelie/packages">Adélie Linux package repository</ulink> in the Git system. Choose the <guibutton>Fork</guibutton> button in the middle of the screen; if prompted, select your name as the repository destination.</para>
+ <para>The system will redirect you to your new fork. Use the <guilabel>"SSH"</guilabel> URL to clone the repository on your local computer by running the following command:</para>
+ <para><prompt>$</prompt> <command>git <parameter>clone</parameter> <userinput>git@code.foxkit.us:yourname/packages.git</userinput></command></para>
+ <para>where <userinput>yourname</username> is your Git username.</para>
+ </section>
<section>
<title></title>
- <para></para>
</section>
</chapter>