[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnuastro-commits] (no subject)
|
From: |
Mohammad Akhlaghi |
|
Subject: |
[gnuastro-commits] (no subject) |
|
Date: |
Sun, 5 Jun 2016 03:52:39 +0000 (UTC) |
branch: master
commit ae5c64bd2d614d5f476164e1b6a9a6c52db5f9e0
Author: Mohammad Akhlaghi <address@hidden>
Date: Sun Jun 5 12:37:03 2016 +0900
Updated top Gnuastro webpage
The GNU Autoconf webpage had a nice "Table of contents" box on the top
right of the webpage. This makes it easier to navigate this page and have a
general overview without scrolling down. So it was implemented in
Gnuastro's top page too. Some other noteworthy updates are:
- A green highlight was put on the "Bug fixed:" under the main download
link.
- Addition of a new "Report a bug" title in the main webpage (again
following Autoconf).
- In the "Development" section of the "Getting involved" title, an
explanation was added about the version controlled source, how to see
the history online and also cloning commands.
- The emails in the page were also updated to work more successfully in an
email client if someone clicks on them.
---
doc/gnuastro-top.html | 238 +++++++++++++++++++++++++++++++++++--------------
1 file changed, 169 insertions(+), 69 deletions(-)
diff --git a/doc/gnuastro-top.html b/doc/gnuastro-top.html
index fdc422d..816ff8e 100644
--- a/doc/gnuastro-top.html
+++ b/doc/gnuastro-top.html
@@ -39,37 +39,69 @@
<title>GNU Astronomy Utilities - Gnuastro -
- GNU Project - Free Software Foundation</title>
-<style>
-p.cartouche
-{
- margin:10px;
- border:solid;
- padding-left:1em;
- border-width:1px;
- padding-right:1em;
- border-radius:10px;
- background-color:#FF9912;
+<style type="text/css"><!--
+#table-of-contents {
+ float: left;
+ margin: 1.3em 0 1.5em 0;
}
-</style>
+#content #table-of-contents h4 { margin-top: .8em; }
+#table-of-contents a:hover { text-decoration: underline; }
+#table-of-contents h4 { text-align: center; }
+h3 { clear: both; }
+#content h3 a[href^="#"] {
+ color: #333; text-decoration: none;
+}
+#table-of-contents a { text-decoration: none; }
address@hidden (min-width: 40em) {
+ h3 { clear: none; }
+ #table-of-contents {
+ float: right;
+ margin: 1.3em 0 1em 1.5em;
+ }
+}
+--></style>
+
+
+
+
+
+
+
<!--#include virtual="/server/gnun/initial-translations-list.html" -->
<!--#include virtual="/server/banner.html" -->
<h2>GNU Astronomy Utilities</h2>
+<hr />
+<div id="table-of-contents" class="emph-box">
+<h4>Table of Contents</h4>
+<ul>
+ <li><a href="#introduction">Introduction</a></li>
+ <li><a href="#download">Download</a></li>
+ <li><a href="#documentation">Book (documentation)</a></li>
+ <li><a href="#mail">Gnuastro mailing lists</a></li>
+ <li><a href="#bug">Report a Bug</a></li>
+ <li><a href="#contribute">Getting involved</a></li>
+ <li><a href="#license">Licensing</a></li>
+</ul>
+<hr class="no-display"/>
+</div>
+
+
+
+
+
+<h3 id="introduction">Introduction</h3>
<p>The GNU Astronomy Utilities (Gnuastro) is an official GNU package
consisting of separate programs for the manipulation and analysis of
astronomical data. All the various utilities share the same basic
-command line user interface for the comfort of both the users and
+command-line user interface for the comfort of both the users and
developers. GNU Astronomy Utilities is written to comply fully with
-the <a href="https://www.gnu.org/prep/standards/";>GNU coding
-standards</a> so it integrates finely with the GNU/Linux operating
-system. This also enables astronomers to expect a fully familiar
-experience in the source code, building, installing and command line
-user interaction that they have seen in all the other GNU software
-that they use.</p>
-
-
-<h3>For starters</h3>
+the <a href="https://www.gnu.org/prep/standards/";>GNU coding standards</a>
+so it integrates finely with the GNU/Linux operating system. This also
+enables astronomers to expect a fully familiar experience in the source
+code, building, installing and command-line user interaction that they have
+seen in all the other GNU software that they use.</p>
In case you are new to Gnuastro, you might find these links useful:
@@ -89,13 +121,17 @@ for entertaining and easy to read real world examples of
using
</ul>
-<h3 id="download">Downloading Gnuastro</h3>
+
+
+
+<h3 id="download">Download</h3>
<p>The current stable release
is <a href="http://ftp.gnu.org/gnu/gnuastro/gnuastro-0.1.tar.gz";>Gnuastro
0.1</a> (30 May 2016).
Use <a href="http://ftpmirror.gnu.org/gnuastro/gnuastro-0.1.tar.gz";>a
- mirror</a> if possible.<br /><b>Bug fixed:</b> Please use
+ mirror</a> if possible.<br /><span style="background-color:
+ #66cc00"><b>Bug fixed:</b></span> Please use
<a href="http://alpha.gnu.org/gnu/gnuastro/gnuastro-alpha-latest.tar.gz";>this
alpha-release</a> if the <code>make</code> command from the 0.1 release
fails with an '<code>error: ld</code>'
@@ -107,17 +143,7 @@ for entertaining and easy to read real world examples of
using
the <a
href="http://git.savannah.gnu.org/cgit/gnuastro.git/plain/NEWS?id=gnuastro_v0.1";>NEWS</a>
file.</p>
-<p>Previous versions and PGP signatures are available
- at <a
href="http://ftp.gnu.org/gnu/gnuastro";>http://ftp.gnu.org/gnu/gnuastro</a>. Use
<a href="http://ftpmirror.gnu.org/gnuastro";>a
- mirror</a> if possible. </p>
-
-<p>The
- canonical <a
href="http://ftp.gnu.org/gnu/gnuastro/gnuastro-latest.tar.gz";></a<>http://ftp.gnu.org/gnu/gnuastro/gnuastro-latest.tar.gz</a>
- is also available for the latest
- release. Use <a
href="http://ftpmirror.gnu.org/gnuastro/gnuastro-latest.tar.gz";>http://ftpmirror.gnu.org/gnuastro/gnuastro-latest.tar.gz</a>
- if possible.</p>
-
-
<p>The <a href="manual/html_node/Installation.html">Installation</a>
+<p>The <a href="manual/html_node/Installation.html">Installation</a>
chapter of the <a href="manual/">Gnuastro book</a>
thoroughly discusses
the <a href="manual/html_node/Dependencies.html">dependencies</a>,
@@ -133,27 +159,41 @@ for entertaining and easy to read real world examples of
using
check</code>, and <code>make install</code> are enough
(see <a href="manual/html_node/Quick-start.html">Quick start</a>).</p>
+<p>Previous versions and PGP signatures are available
+ at <a
href="http://ftp.gnu.org/gnu/gnuastro";>http://ftp.gnu.org/gnu/gnuastro</a>. Use
<a href="http://ftpmirror.gnu.org/gnuastro";>a
+ mirror</a> if possible. </p>
+
+<p>The
+ canonical <a
href="http://ftp.gnu.org/gnu/gnuastro/gnuastro-latest.tar.gz";></a<>http://ftp.gnu.org/gnu/gnuastro/gnuastro-latest.tar.gz</a>
+ is also available for the latest
+ release. Use <a
href="http://ftpmirror.gnu.org/gnuastro/gnuastro-latest.tar.gz";>http://ftpmirror.gnu.org/gnuastro/gnuastro-latest.tar.gz</a>
+ if possible.</p>
+
+
+
+
+
<h3 id="documentation">Gnuastro book (documentation)</h3>
-<p>The <a href="manual/">Gnuastro book</a> (official Gnuastro
-documentation) is available online in various formats, as
+<p>The <a href="manual/">Gnuastro book</a> (official Gnuastro documentation
+or manual) is available online in various formats, as
is <a href="http://www.gnu.org/manual/manual.en.html";>documentation for
most GNU software</a>. After installation, you can access the complete
-book, or the sections related to individual utilities on the command line
+book, or the sections related to individual utilities on the command-line
(in <a href="../texinfo/manual/info/info.html">Info</a>
format). See <a href="manual/html_node/Getting-help.html">Getting help</a>
-for more. As a summary, here are the ways you can get immediately find your
-answers on the command line:
+for more. As a summary, here are the ways you can immediately find navigate
+to any major part of the book on the command-line:
<ul>
- <li><code>info gnuastro</code>: To view the complete GNU Astronomy
- Utilities manual.</li>
+ <li><code>info gnuastro</code>: To view the complete Gnuastro book from
+ the beginning.</li>
<li><code>info ProgramName</code>: To view the complete section about a
specific utility. For example <code>info NoiseChisel</code>
or <code>info ImageCrop</code>.</li>
<li><code>info astprogname</code>: To only view the "Invoking
ProgramName" sub-section of the manual. Each program has this
- subsection which explains the input(s), output(s) and command line
+ subsection which explains the input(s), output(s) and command-line
options for that particular program. For example <code>info
astnoisechisel</code> or <code>info astimgcrop</code>.</li>
<li><code>astprogname --help</code>: A description and full list of
@@ -166,7 +206,10 @@ answers on the command line:
</ul>
-<h3 id="mail">Mailing lists</h3>
+
+
+
+<h3 id="mail">Gnuastro mailing lists</h3>
<p>Gnuastro has the following mailing lists:</p>
@@ -202,26 +245,62 @@ issue, you can escalate to the general
<a href="http://lists.gnu.org/mailman/listinfo/security";>security</a>
mailing list for advice.</p>
-<h3 id="contribute">Getting involved</h3>
-<p>The most important principle behind Gnuastro is to be easy for
-anyone to hack into it (add a new feature, change an existing one, fix
-a problem and most importantly to understand what is going on under
-the hood), please
-see <a href="manual/html_node/Science-and-its-tools.html">Science and
-its tools</a>. So you are most welcome and highly encouraged to
-contribute. There is even a full chapter dedicated
-to <a href="manual/html_node/Developing.html">Developing</a> to make
-it as easy as possible for you to get involved. Also
-see <a href="http://www.gnu.org/help/";>How to help GNU</a> for joining
-the full GNU project.</p>
+
+<h3 id="bug">Report a bug</h3>
+<p>The <a href="manual/html_node/Report-a-bug.html">Report a bug</a>
+ section of the manual thoroughly explains the process to report a bug,
+ please read that section. As a summary, first have a look at
+ the <a href="https://savannah.gnu.org/bugs/?group=gnuastro";
+ target="_blank">Gnuastro bug archive</a>. Click on the "<i>Display
+ criteria</i>" (above the list), choose "Any" in the "<i>Open/Closed</i>"
+ drop-down menu, and under "<i>Category</i>" choose the part of Gnuastro
+ that corresponds to your bug. By clicking on the "Apply" button, only the
+ relevant bugs will be listed. Green items have been solved and closed,
+ while red items are still open. If your bug isn't listed, please take one
+ of the following steps. Please try to be as descriptive as possible and
+ include the Gnuastro version you are using along with the commands or
+ code that created the bug so we can reproduce and thus fix it faster.</p>
+
+<ul>
+ <li><a href="https://savannah.gnu.org/support/?func=additem&group=gnuastro";
+ target="_blank">Submit your bug</a> through the main project management
+ webpage. This is the recommended way to inform us of your bug. Please
+ also fill out the meta-data (category, item group and etc) as much as
+ possible.</li>
+ <li>Send a mail
+ to <a href="mailto:bug-gnuastro=at=gnu.org";>bug-gnuastro::at::gnu.org</a>
+ which is one of Gnuastro's <a href="#mail">mailing lists</a>. This will
+ be slower than the first. Because of the large number of spam messages,
+ this mailing list is moderated and other developers will only see it
+ after it has been approved. So to immediately let all the developers
+ know, please use the first option.</li>
+</ul>
+
+
+
+
+
+<h3 id="contribute">Getting involved</h3>
+
+<p>The most important principle behind Gnuastro is to be easy for anyone to
+ hack into it (add a new feature, change an existing one, fix a problem
+ and most importantly to understand what is going on under the hood),
+ please see <a href="manual/html_node/Science-and-its-tools.html">Science
+ and its tools</a>. So you are most welcome and highly encouraged to
+ contribute. There is even a full chapter dedicated
+ to <a href="manual/html_node/Developing.html">Developing</a> to make it
+ as easy as possible for you to get involved. Also
+ see <a href="http://www.gnu.org/help/";>How to help GNU</a> for joining
+ the full GNU project.</p>
+
<dl>
<dt>Test releases</dt>
-<dd>Trying the latest test release (when available) is always
-appreciated. Test releases of Gnuastro can be found at
+<dd>Trying the latest test release (when available) is always appreciated.
+Test releases of Gnuastro can be found at
<a
href="http://alpha.gnu.org/gnu/gnuastro/";>http://alpha.gnu.org/gnu/gnuastro/</a>
(via HTTP) and
<a
href="ftp://alpha.gnu.org/gnu/gnuastro/";>ftp://alpha.gnu.org/gnu/gnuastro/</a>
@@ -230,17 +309,15 @@ appreciated. Test releases of Gnuastro can be found at
<dt>Development</dt>
-<dd>GNU Astronomy Utilities is still under active development. So if
-you are interested, please have a look at
-the <a href="manual/html_node/Developing.html">Developing</a> chapter
-of the documentation and start hacking into Gnuastro or even write
-your own utility within it. If you feel you want to share your work as
-an official section of Gnuastro, please contact the maintainer
-(below). For development
+<dd>GNU Astronomy Utilities is still under active development. So if you
+are interested, please have a look at
+the <a href="manual/html_node/Developing.html">Developing</a> chapter of
+the documentation and start hacking into Gnuastro or even write your own
+utility within it. For development
sources, <a href="https://savannah.gnu.org/bugs/?group=gnuastro";>bug
trackers</a>, <a href="https://savannah.gnu.org/task/?group=gnuastro";>task
-trackers</a> (planned features to be added), and other information,
-please see the
+trackers</a> (planned features to be added), and other information, please
+see the
<a href="http://savannah.gnu.org/projects/gnuastro/";>Gnuastro project
page</a> at <a href="http://savannah.gnu.org";>savannah.gnu.org</a>. The
trackers can be a good starting point if you want to get involved in the
@@ -251,18 +328,41 @@ and/or
the <a
href="https://lists.gnu.org/mailman/listinfo/gnuastro-commits";>gnuastro-commits</a>
mailing lists.</dd>
+<dd>Gnuastro is version controlled using
+ Git. The <a href="manual/html_node/Version-controlled-source.html">version
+ controlled source</a> can
+ be <a href="http://git.savannah.gnu.org/cgit/gnuastro.git/tree/";>inspected
+ online</a>, or you
+ can <a href="http://git.savannah.gnu.org/cgit/gnuastro.git/log/";>see the
+ latest history</a>. To keep a local copy, please clone it onto your
+ system with any one of the following commands (if it works, the first one
+ is recommended).
+ <pre class="emph-box"><samp>git clone git://git.sv.gnu.org/gnuastro
+git clone http://git.sv.gnu.org/r/gnuastro.git
+</samp></pre></dd>
+
+<dd>To configure and build the version controlled source, you will need to
+ <a href="manual/html_node/Bootstrapping.html">bootstrap</a> (also
+ see <a href="manual/html_node/Bootstrapping-dependencies.html">bootstrapping
+ dependencies</a>). See
+ the <a href="manual/html_node/Forking-tutorial.html">forking tutorial</a>
+ for a demonstration of the Gnuastro project workflow.</dd>
+
<dt>Maintainer</dt>
<dd>GNU Astronomy Utilities is created and maintained by
<a href="http://astr.tohoku.ac.jp/~akhlaghi";>Mohammad
Akhlaghi</a>
-<a href="mailto:akhlaghi::at::gnu.org";><akhlaghi::at::gnu.org></a>.
-Please use the mailing lists for contact.</dd>
+<a href="mailto:akhlaghi=at=gnu.org";><akhlaghi::at::gnu.org></a>.
+Please use the mailing lists for contact. </dd>
</dl>
+
+
+
<h3 id="license">Licensing</h3>
<p>GNU Astronomy Utilities (Gnuastro) is free software; you can
@@ -319,7 +419,7 @@ of this article.</p>
There is more detail about copyright years in the GNU Maintainers
Information document, www.gnu.org/prep/maintain. -->
-<p>Copyright © 2015 Free Software Foundation, Inc.</p>
+<p>Copyright © 2015-2016 Free Software Foundation, Inc.</p>
<p>This page is licensed under a <a rel="license"
href="http://creativecommons.org/licenses/by-nd/3.0/us/";>Creative