25727021 s/java.net/github.com/g (tweak README format)
authorJohn Beck <John.Beck@Oracle.COM>
Wed, 15 Mar 2017 15:41:22 -0700
changeset 7763 2a3817cf33cb
parent 7760 4ab84455407c
child 7768 b2bf3840279b
25727021 s/java.net/github.com/g (tweak README format)
Makefile
README
README.md
--- a/Makefile	Wed Mar 15 12:33:24 2017 -0700
+++ b/Makefile	Wed Mar 15 15:41:22 2017 -0700
@@ -47,6 +47,6 @@
 	@+echo "$(TARGET) [email protected]" ; $(MAKE) -C [email protected] $(TARGET)
 
 README.md:	README
-	markdown_py < $< > [email protected]
+	/usr/bin/cp -f $< [email protected]
 
 FORCE:
--- a/README	Wed Mar 15 12:33:24 2017 -0700
+++ b/README	Wed Mar 15 15:41:22 2017 -0700
@@ -1,91 +1,82 @@
-
-	    Getting started with the Userland Consolidation
+# Getting started with the Userland Consolidation
 
+## Getting Started
+This README provides a very brief overview of the gate, how to retrieve
+a copy, and how to build it.  Detailed documentation about the Userland
+gate can be found in the 'doc' directory.
 
-Getting Started
+## Overview
+The Userland consolidation maintains a project at
 
-    This README provides a very brief overview of the gate, how to retrieve
-    a copy, and how to build it.  Detailed documentation about the Userland
-    gate can be found in the 'doc' directory.
+     https://github.com/oracle/solaris-userland
 
-Overview
-
-    The Userland consolidation maintains a project at
-
-         https://github.com/oracle/solaris-userland
+That repo contains build recipes, patches, IPS manifests, etc. necessary
+to download, prep, build, test, package and publish open source software.
+The build infrastructure is similar to that of the SFW consolidation in
+that it makes use of hierarchical Makefiles which provide dependency and
+recipe information for building the components.  In order to build the
+contents of the Userland gate, you need to clone it.  Since you are
+reading this, you probably already have.
 
-    That repo contains build recipes, patches, IPS manifests, etc. necessary
-    to download, prep, build, test, package and publish open source software.
-    The build infrastructure is similar to that of the SFW consolidation in
-    that it makes use of hierarchical Makefiles which provide dependency and
-    recipe information for building the components.  In order to build the
-    contents of the Userland gate, you need to clone it.  Since you are
-    reading this, you probably already have.
+## Getting the Bits
+As mentioned, the gate is stored in a Mercurial repository.  In order to
+build or develop in the gate, you will need to clone it.  You can do so
+with the following command
 
-Getting the Bits
+  $ git clone https://github.com/oracle/solaris-userland.git /scratch/clone
 
-    As mentioned, the gate is stored in a Mercurial repository.  In order to
-    build or develop in the gate, you will need to clone it.  You can do so
-    with the following command
-    
-      $ git clone https://github.com/oracle/solaris-userland.git /scratch/clone
+This will create a replica of the various pieces that are checked into the
+source code management system, but it does not retrieve the community
+source archives associated with the gate content.  To download the
+community source associated with your cloned workspace, you will need to
+execute the following:
 
-    This will create a replica of the various pieces that are checked into the
-    source code management system, but it does not retrieve the community
-    source archives associated with the gate content.  To download the
-    community source associated with your cloned workspace, you will need to
-    execute the following:
+  $ cd /scratch/clone/components
+  $ gmake download
 
-      $ cd /scratch/clone/components
-      $ gmake download
-
-    This will use GNU make and the downloading tool in the gate to walk through
-    all of the component directories downloading and validating the community
-    source archives from the gate machine or their canonical source repository.
+This will use GNU make and the downloading tool in the gate to walk through
+all of the component directories downloading and validating the community
+source archives from the gate machine or their canonical source repository.
 
-    There are two variation to this that you may find interesting.  First, you
-    can cause gmake(1) to perform it's work in parallel by adding '-j (jobs)'
-    to the command line.  Second, if you are only interested in working on a
-    particular component, you can change directories to that component's
-    directory and use 'gmake download' from that to only get it's source
-    archive.
+There are two variation to this that you may find interesting.  First, you
+can cause gmake(1) to perform it's work in parallel by adding '-j (jobs)'
+to the command line.  Second, if you are only interested in working on a
+particular component, you can change directories to that component's
+directory and use 'gmake download' from that to only get it's source
+archive.
 
-Building the Bits.
-
-    You can build individual components or the contents of the entire gate.
+## Building the Bits.
+You can build individual components or the contents of the entire gate.
 
-  Component build
-
-    If you are only working on a single component, you can just build it using
-    following:
+### Component build
+If you are only working on a single component, you can just build it using
+following:
 
-      setup the workspace for building components
+  setup the workspace for building components
 
-        $ cd (your-workspace)/components ; gmake setup
+    $ cd (your-workspace)/components ; gmake setup
 
-      build the individual component
+  build the individual component
 
-        $ cd (component-dir) ; gmake publish
-
-  Complete Top Down build  
+    $ cd (component-dir) ; gmake publish
 
-    Complete top down builds are also possible by simply running
+### Complete Top Down build
+Complete top down builds are also possible by simply running
 
-      $ cd (your-workspace)/components
-      $ gmake publish
+  $ cd (your-workspace)/components
+  $ gmake publish
 
-    The 'publish' target will build each component and publish it to the
-    workspace IPS repo.
-    Tools to help facilitate build zone creation will be integrated
-    shortly.  If the zone you create to build your workspace in does not have
-    networking enabled, you can pre-download any community source archives into
-    your workspace from the global with:
+The 'publish' target will build each component and publish it to the
+workspace IPS repo.
+Tools to help facilitate build zone creation will be integrated
+shortly.  If the zone you create to build your workspace in does not have
+networking enabled, you can pre-download any community source archives into
+your workspace from the global with:
 
-      $ cd (your-workspace)/components
-      $ gmake download
+  $ cd (your-workspace)/components
+  $ gmake download
 
-  You can add parallelism to your builds by adding '-j (jobs)' to your gmake
+- You can add parallelism to your builds by adding '-j (jobs)' to your gmake
   command line arguments.
-
-  The gate should only incrementally build what it needs to based on what has
+- The gate should only incrementally build what it needs to based on what has
   changed since you last built it.
--- a/README.md	Wed Mar 15 12:33:24 2017 -0700
+++ b/README.md	Wed Mar 15 15:41:22 2017 -0700
@@ -1,12 +1,12 @@
-<pre><code>    Getting started with the Userland Consolidation
-</code></pre>
-<p>Getting Started</p>
-<pre><code>This README provides a very brief overview of the gate, how to retrieve
+# Getting started with the Userland Consolidation
+
+## Getting Started
+This README provides a very brief overview of the gate, how to retrieve
 a copy, and how to build it.  Detailed documentation about the Userland
 gate can be found in the 'doc' directory.
-</code></pre>
-<p>Overview</p>
-<pre><code>The Userland consolidation maintains a project at
+
+## Overview
+The Userland consolidation maintains a project at
 
      https://github.com/oracle/solaris-userland
 
@@ -17,9 +17,9 @@
 recipe information for building the components.  In order to build the
 contents of the Userland gate, you need to clone it.  Since you are
 reading this, you probably already have.
-</code></pre>
-<p>Getting the Bits</p>
-<pre><code>As mentioned, the gate is stored in a Mercurial repository.  In order to
+
+## Getting the Bits
+As mentioned, the gate is stored in a Mercurial repository.  In order to
 build or develop in the gate, you will need to clone it.  You can do so
 with the following command
 
@@ -44,12 +44,12 @@
 particular component, you can change directories to that component's
 directory and use 'gmake download' from that to only get it's source
 archive.
-</code></pre>
-<p>Building the Bits.</p>
-<pre><code>You can build individual components or the contents of the entire gate.
-</code></pre>
-<p>Component build</p>
-<pre><code>If you are only working on a single component, you can just build it using
+
+## Building the Bits.
+You can build individual components or the contents of the entire gate.
+
+### Component build
+If you are only working on a single component, you can just build it using
 following:
 
   setup the workspace for building components
@@ -59,9 +59,9 @@
   build the individual component
 
     $ cd (component-dir) ; gmake publish
-</code></pre>
-<p>Complete Top Down build  </p>
-<pre><code>Complete top down builds are also possible by simply running
+
+### Complete Top Down build
+Complete top down builds are also possible by simply running
 
   $ cd (your-workspace)/components
   $ gmake publish
@@ -75,8 +75,8 @@
 
   $ cd (your-workspace)/components
   $ gmake download
-</code></pre>
-<p>You can add parallelism to your builds by adding '-j (jobs)' to your gmake
-  command line arguments.</p>
-<p>The gate should only incrementally build what it needs to based on what has
-  changed since you last built it.</p>
\ No newline at end of file
+
+- You can add parallelism to your builds by adding '-j (jobs)' to your gmake
+  command line arguments.
+- The gate should only incrementally build what it needs to based on what has
+  changed since you last built it.