summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukas Fleischer <calcurse@cryptocrack.de>2011-03-02 16:02:05 +0100
committerLukas Fleischer <calcurse@cryptocrack.de>2011-03-02 16:07:09 +0100
commit94336600bdcf14cdf7907c34691cdc2be9be0928 (patch)
tree8ebe662ea3bb11ea63a9bdc87e301fc38fff42c0
parent1af3f437f428c2e53abdecffd08073aac35b26d7 (diff)
downloadcalcurse.org-94336600bdcf14cdf7907c34691cdc2be9be0928.tar.gz
calcurse.org-94336600bdcf14cdf7907c34691cdc2be9be0928.zip
Restructure "Contributions" page, add mailing list info.
Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
-rw-r--r--contrib/index.html68
-rw-r--r--devel/index.html151
-rw-r--r--downloads/index.html41
-rw-r--r--index.html20
-rw-r--r--screenshots/index.html3
-rw-r--r--support/index.html67
6 files changed, 224 insertions, 126 deletions
diff --git a/contrib/index.html b/contrib/index.html
deleted file mode 100644
index 7a75e76..0000000
--- a/contrib/index.html
+++ /dev/null
@@ -1,68 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
- "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
- <head>
- <title>calcurse.org</title>
-
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <meta http-equiv="Content-Style-Type" content="text/css" />
-
- <link rel="stylesheet" type="text/css" href="/css/style.css" media="all" />
- </head>
-
- <body>
- <div id="header">
- <h1>calcurse</h1>
- <ul id="nav">
- <li><a href="/">About</a></li>
- <li><a href="/screenshots">Screenshots</a></li>
- <li><a href="/downloads">Downloads</a></li>
- <li><a href="/contrib" class="current">Contribute</a></li>
- </ul>
- <p style="clear:both;"></p>
- </div>
- <div id="contents">
-<h2 id="contrib">Contribute</h2>
-<p>
- Found a bug? Want to be a translator? Want to do some work on the calcurse
- website?
-</p>
-<p>
- Any of the following contributions are welcome:
-</p>
-<ul>
- <li>bug reports (see <a href="#bugs">Reporting Bugs</a>),</li>
- <li>code reviews/patches (see <a href="#gs">Getting Started</a>),</li>
- <li>feature/enhancement requests,</li>
- <li>translations (check the manual),</li>
- <li>any kind of feedback,</li>
- <li>other ideas and discussions on the mailing list (coming soon!)</li>
-</ul>
-
-<h2 id="bugs">Reporting Bugs</h2>
-<p>
- If you happen to find a bug, please send a short mail to <tt>bugs at calcurse
- dot org</tt>. Please try to include all relevant information, so we don't
- need to make a bunch of unnecessary further queries.
-</p>
-<p>
- There will also be a mailing list, soon.
-</p>
-
-<h2 id="gs">Getting Started</h2>
-<ul>
- <li>Get the <a href="/downloads/#devel">latest development code</a>.</li>
- <li>Compile <tt>calcurse</tt> from source.</li>
- <li>Subscribe to the mailing list (coming soon!)</li>
- <li>
- Before you start coding, have a look at the current source code and discuss
- your thoughts on the mailing list.
- </li>
-</ul>
-<p>
- Happy hacking!
-</p>
- </div>
- </body>
-</html>
diff --git a/devel/index.html b/devel/index.html
new file mode 100644
index 0000000..254e27f
--- /dev/null
+++ b/devel/index.html
@@ -0,0 +1,151 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>calcurse.org</title>
+
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+
+ <link rel="stylesheet" type="text/css" href="/css/style.css" media="all" />
+ </head>
+
+ <body>
+ <div id="header">
+ <h1>calcurse</h1>
+ <ul id="nav">
+ <li><a href="/">About</a></li>
+ <li><a href="/screenshots">Screenshots</a></li>
+ <li><a href="/downloads">Downloads</a></li>
+ <li><a href="/support">Support</a></li>
+ <li><a href="/devel" class="current">Development</a></li>
+ </ul>
+ <p style="clear:both;"></p>
+ </div>
+ <div id="contents">
+<h2 id="intro">Development</h2>
+<p>
+ <tt>calcurse</tt> is released under the
+ <a href="http://www.gnu.org/licenses/gpl2.txt">GPLv2</a> license, so feel
+ free to download, modify and redistribute it unter the terms of the GPL.
+</p>
+<p>
+ The whole source code currently is under version control using
+ <a href="http://git-scm.com/">Git</a> as VCS. You can either view recent
+ changes and stats, browse the source tree, and download snapshot tarballs
+ through our <a href="http://git.calcurse.org/calcurse.git/">cgit web
+ interface</a> or retrieve a local copy of the development tree using:
+</p>
+<pre>
+$ git clone git://git.calcurse.org/calcurse.git
+</pre>
+<p>
+ That creates a new directory <tt>calcurse</tt> containing the cloned
+ repository. A graphical view of recent development can be requested using the
+ <tt>gitk(1)</tt> frontend:
+</p>
+<pre>
+$ gitk --all
+</pre>
+<p>
+ To update your existing local working copy to the current point of
+ development, run:
+</p>
+<pre>
+$ git pull origin master
+</pre>
+<p>
+ For further documentation and tutorials, check the
+ <a href="http://git-scm.com/">Git website</a>.
+</p>
+<h2 id="build">Building calcurse</h2>
+<p>
+ To build <tt>calcurse</tt> from development sources, run:
+</p>
+<pre>
+$ ./autogen.sh
+$ ./configure
+$ make
+</pre>
+<h2 id="patches">Submitting Patches</h2>
+<p>
+ Patches are always appreciated and should be sent to <tt>misc at calcurse dot
+ org</tt> for discussion or to <tt>bugs at calcurse dot org</tt> if they are
+ mere bug fixes. You will need to <a href="/support">subscribe</a> to the
+ mailing lists before submitting. Signed-off patches produced by
+ <tt>git-format-patch(1)</tt> and submitted as an inline attachments via
+ <tt>git-send-email(1)</tt> are preferred.
+</p>
+<p>
+ If you've never used Git before, try to stick to following workflow:
+</p>
+<ol>
+ <li>
+<p>
+ Whenever you want to work on a new feature, do it in a separate branch.
+ Having custom commits in the <tt>master</tt> branch might cause conflicts
+ when pulling in new changes. Creating a new development branch
+ <strong>before</strong> doing any changes is good practice. And even before
+ doing that, you should update the <tt>master</tt> branch of your working
+ copy:
+</p>
+<pre>
+$ git pull origin master
+$ git branch foo
+</pre>
+ </li>
+ <li>
+<p>
+ Edit files in the source tree and test your changes. When everything seems to
+ be fine, you're ready to commit to your local working tree:
+</p>
+<pre>
+$ git commit -as
+</pre>
+<p>
+ If you added or removed files, you probaly need to run <tt>git add</tt> or
+ <tt>git rm</tt> before committing so that Git is aware of them.
+</p>
+<p>
+ If you work on more than a small bug fix, you should split your work into
+ several commits. Try to keep your commits small and focused. Smaller patches
+ are way easier to review and have a better chance of being included in
+ mainline development. Also try to make your commit messages brief and
+ descriptive.
+</p>
+ </li>
+ <li>
+<p>
+ As soon as you finished all your work, test everything again and create a
+ patch series:
+</p>
+<pre>
+$ git format-patch master
+</pre>
+ </li>
+ <li>
+<p>
+ Send your patch series to one of the mailing lists:
+</p>
+<pre>
+$ git send-email *.patch
+</pre>
+ </li>
+ <li>
+<p>
+ Optionally delete your working branch if you don't need it anymore:
+</p>
+<pre>
+$ git branch -D foo
+</pre>
+ </li>
+</ol>
+<p>
+ In case you are interested in more details and features of Git, check the
+ <a href="http://git-scm.com/">Git website</a>. <em>Version Control with
+ Git</em> by <em>Jon Loeliger</em> also is a good book to start with.
+</p>
+ </div>
+ </body>
+</html>
diff --git a/downloads/index.html b/downloads/index.html
index 7f0a745..0aaa030 100644
--- a/downloads/index.html
+++ b/downloads/index.html
@@ -18,7 +18,8 @@
<li><a href="/">About</a></li>
<li><a href="/screenshots">Screenshots</a></li>
<li><a href="/downloads" class="current">Downloads</a></li>
- <li><a href="/contrib">Contribute</a></li>
+ <li><a href="/support">Support</a></li>
+ <li><a href="/devel">Development</a></li>
</ul>
<p style="clear:both;"></p>
</div>
@@ -183,44 +184,6 @@ collection. (packaged for NetBSD by Zul - from France)
calcurse-2.5-1mdv2009.1.src.rpm (kindly provided by Fran├žois)
</li>
</ul>
-
-<h2 id="devel">Development Source Code</h2>
-<p>
- <tt>calcurse</tt> currently is under version control using
- <a href="http://git-scm.com/">Git</a>. To retrieve a local copy of the
- development tree, you can use:
-</p>
-<pre>
-$ git clone git://git.calcurse.org/calcurse.git
-</pre>
-<p>
- That creates a new directory <tt>calcurse</tt> containing the cloned
- repository. A graphical view of recent development can be requested using the
- <tt>gitk(1)</tt> frontend:
-</p>
-<pre>
-$ gitk --all
-</pre>
-<p>
- To pull in the latest changes, just run:
-</p>
-<pre>
-$ git pull
-</pre>
-<p>
- If you applied some changes to the source code, you can commit these via:
-</p>
-<pre>
-$ git commit -a
-</pre>
-<p>
- ... and use <tt>git-format-patch(1)</tt> and <tt>git-send-email(1)</tt> to
- send a mail to the mailing list.
-</p>
-<p>
- For further documentation and tutorials, check the
- <a href="http://git-scm.com/">Git website</a>.
-</p>
</div>
</body>
</html>
diff --git a/index.html b/index.html
index e5d0b06..8afafe1 100644
--- a/index.html
+++ b/index.html
@@ -18,7 +18,8 @@
<li><a href="/" class="current">About</a></li>
<li><a href="/screenshots">Screenshots</a></li>
<li><a href="/downloads">Downloads</a></li>
- <li><a href="/contrib">Contribute</a></li>
+ <li><a href="/support">Support</a></li>
+ <li><a href="/devel">Development</a></li>
</ul>
<p style="clear:both;"></p>
</div>
@@ -45,23 +46,6 @@ documented within an online help system.
<li>complete online help system</li>
<li>...</li>
</ul>
-
-<h2 id="authors">Authors</h2>
-<p>
- Currently active calcurse developers:
-</p>
-<ul>
- <li>Frederic Culot <tt>&lt;calcurse at culot dot org&gt;</tt></li>
- <li>Lukas Fleischer <tt>&lt;calcurse at cryptocrack dot de&gt;</tt></li>
-</ul>
-
-<h2 id="contact">Contact</h2>
-<p>
- You can contact us on <tt>info at calcurse dot org</tt>.
-</p>
-<p>
- A mailing list is going to be set up, soon!
-</p>
</div>
</body>
</html>
diff --git a/screenshots/index.html b/screenshots/index.html
index 06973b5..b42931b 100644
--- a/screenshots/index.html
+++ b/screenshots/index.html
@@ -24,7 +24,8 @@
<li><a href="/">About</a></li>
<li><a href="/screenshots" class="current">Screenshots</a></li>
<li><a href="/downloads">Downloads</a></li>
- <li><a href="/contrib">Contribute</a></li>
+ <li><a href="/support">Support</a></li>
+ <li><a href="/devel">Development</a></li>
</ul>
<p style="clear:both;"></p>
</div>
diff --git a/support/index.html b/support/index.html
new file mode 100644
index 0000000..e3be70c
--- /dev/null
+++ b/support/index.html
@@ -0,0 +1,67 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>calcurse.org</title>
+
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+
+ <link rel="stylesheet" type="text/css" href="/css/style.css" media="all" />
+ </head>
+
+ <body>
+ <div id="header">
+ <h1>calcurse</h1>
+ <ul id="nav">
+ <li><a href="/">About</a></li>
+ <li><a href="/screenshots">Screenshots</a></li>
+ <li><a href="/downloads">Downloads</a></li>
+ <li><a href="/support" class="current">Support</a></li>
+ <li><a href="/devel">Development</a></li>
+ </ul>
+ <p style="clear:both;"></p>
+ </div>
+ <div id="contents">
+<h2 id="support">Support</h2>
+<p>
+ <tt>calcurse</tt> has a small, but helpful community.
+</p>
+<p>
+ Your first point of contact are the <a href="#ml">mailing lists</a>. Please
+ be sure to read the relevant parts of the user manual (included in the
+ release tarballs) before asking questions.
+</p>
+
+<h2 id="ml">Mailing Lists</h2>
+<ul>
+ <li>
+ <tt>misc at calcurse dot org</tt> &ndash; for calcurse users, development
+ and general discussion
+ </li>
+ <li>
+ <tt>bugs at calcurse dot org</tt> &ndash; for bug reports
+ </li>
+</ul>
+<p>
+ To subscribe to one of the mailing lists, send an empty mail to one of the
+ mailing list addresses, adding <tt>+subscribe</tt> to the local part
+ (<tt>misc+subscribe</tt> instead of <tt>misc</tt>, <tt>bugs+subscribe</tt>
+ instead of <tt>bugs</tt>). To unsubscribe, use the <tt>unsubscribe</tt>
+ keyword, respectively.
+</p>
+
+<h2 id="devs">Developer Contact</h2>
+<p>
+ The <tt>calcurse</tt> dev team follows all mailing lists. If you still want
+ to send a direct mail, submit it to <tt>info at calcurse dot org</tt> or to
+ one of the author's private mail addresses:
+</p>
+<ul>
+ <li>Frederic Culot <tt>&lt;calcurse at culot dot org&gt;</tt></li>
+ <li>Lukas Fleischer <tt>&lt;calcurse at cryptocrack dot de&gt;</tt></li>
+</ul>
+ </div>
+ </body>
+</html>