[incubator-nuttx-website] 22/48: Merge HOWTO into README

[xi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx-website.git

commit 74523b44b0826cadee6f8c363524ddf892de17a7
Author: Luciano Resende <lr...@apache.org>
AuthorDate: Sat Dec 5 12:51:11 2015 -0800

    Merge HOWTO into README
---
 HOWTO.md  | 66 ---------------------------------------------------------------
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++------
 2 files changed, 60 insertions(+), 72 deletions(-)

diff --git a/HOWTO.md b/HOWTO.md
deleted file mode 100644
index 78a0ad3..0000000
--- a/HOWTO.md
+++ /dev/null
@@ -1,66 +0,0 @@
-<!--
-{% comment %}
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements.  See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License.  You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-{% endcomment %}
--->
-
-# How to deploy your project's web site
-
-(In the following instructions we assume that your project is called
-'Apache Foo'; search and replace with your actual project name.)
-
-## Setup
-
-1. `cd site`
-2. svn co https://svn.apache.org/repos/asf/foo/site target
-3. `sudo apt-get install rubygems ruby2.1-dev zlib1g-dev` (linux)
-4. `sudo gem install bundler github-pages jekyll`
-5. `bundle install`
-
-## Add javadoc
-
-If your project supports javadoc, you can copy the generated javadoc
-into svn each time you need to re-generate.
-
-1. `cd ..`
-2. `mvn -DskipTests site`
-3. `mv target/site/apidocs site/target`
-
-## Running locally
-
-Before opening a pull request, you can preview your contributions by
-running from within the directory:
-
-1. `bundle exec jekyll serve`
-2. Open [http://localhost:4000](http://localhost:4000)
-
-## Pushing to site
-
-1. `cd site/target`
-2. `svn status`
-3. You'll need to `svn add` any new files
-4. `svn ci`
-
-Within a few minutes, svnpubsub should kick in and you'll be able to
-see the results at
-[foo.apache.org](https://foo.apache.org/).
-
-## Adding contributors
-
-To add a contributor to the project, or to modify existing contributors,
-edit `site/_data/contributors.yml`.
-The [project members]([http://localhost:4000/community.html#project-members]
-list will re-generate.
diff --git a/README.md b/README.md
index 14b9f14..32c6a9d 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,67 @@ limitations under the License.
 
 # Apache Website Template
 
-This project contains a template web site, generated using
-[Jekyll](https://jekyllrb.com/).
+This project contains a template web site that aims to follow all the various required
+Apache Website Policies.
+
+This template was generated using [Jekyll](https://jekyllrb.com/).
 
 To use it, copy the `site` directory into your project.  You must also
 include licensing information from the `LICENSE` and `NOTICE` files in
-your own project. And, we suggest that you include the
-[HOWTO](HOWTO.md) instructions to allow your committers to modify and deploy the site.
+your own project.
+
+# How to deploy your project's web site
+
+(In the following instructions we assume that your project is called
+'Apache Foo'; search and replace with your actual project name.)
+
+## Setup
+
+```
+1. cd site
+2. svn co https://svn.apache.org/repos/asf/foo/site target
+3. sudo apt-get install rubygems ruby2.1-dev zlib1g-dev
+4. sudo gem install bundler github-pages jekyll
+5. bundle install
+```
+
+## Add javadoc
+
+If your project supports javadoc, you can copy the generated javadoc
+into svn each time you need to re-generate.
+
+```
+1. cd ..
+2. mvn -DskipTests site
+3. mv target/site/apidocs site/target
+```
+
+## Running locally
+
+Before opening a pull request, you can preview your contributions by
+running from within the directory:
+
+```
+1. bundle exec jekyll serve
+2. Open [http://localhost:4000](http://localhost:4000)
+```
+
+## Pushing to site
+
+```
+1. cd site/target
+2. svn status
+3. You'll need to `svn add` any new files
+4. svn ci
+```
+
+Within a few minutes, svnpubsub should kick in and you'll be able to
+see the results at
+[foo.apache.org](https://foo.apache.org/).
+
+## Adding contributors
 
-You can see an example of the site at
-[apache-website-template.hydromatic.net](https://apache-website-template.hydromatic.net/).
+To add a contributor to the project, or to modify existing contributors,
+edit `site/_data/contributors.yml`.
+The [project members]([http://localhost:4000/community.html#project-members]
+list will re-generate.