summaryrefslogblamecommitdiffstats
path: root/devel/index.html
blob: 6cd29f9ae034de0ec50bd1438393a874bdfa23e5 (plain) (tree)
1
2
3
4
5
6
7
8

                





                                                                              


                                                                                  


                                                                          
                                                                               
                                                                                     


         


                                                    
                                      






                                                                 
                                
                                       
   


                                                                              


























                                                                               
                                                                          









                                                                               















                                                                               
                                                                              




                                                                         





                                                                                             
    




                                                                           















                                                                             

                                                                     





                                                                               


                              

                                                                             


                                                                    
                                                                                            





                                                                         





























                                                                             
          
                     
                                                                                        

                                                  

         
<!DOCTYPE html>
<html 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" />

    <script type="text/javascript" src="/js/typeface-0.15.js"></script>
    <script type="text/javascript" src="/js/helvetiker_bold.typeface.js"></script>

    <script type="text/javascript" src="/js/jquery-1.7.2.min.js"></script>
    <script type="text/javascript" src="/js/lightbox.js"></script>

    <link rel="stylesheet" type="text/css" href="/css/style.css" media="all" />
    <link rel="stylesheet" type="text/css" href="/css/lightbox.css" media="screen" />
  </head>

  <body>
    <div id="header" class="typeface-js">
      <a href="/"><img src="/images/logo.png" /></a>
      <ul>
        <li><a href="/">About</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">
<h1>Development Information</h1>
<h2 id="source">Development Source</h2>
<p>
  <tt>calcurse</tt> is released under the
  <a href="http://git.calcurse.org/calcurse.git/tree/COPYING">BSD</a> license,
  so feel free to download, modify and redistribute it.
</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>
  If you'd like to follow the maintenance branch (<tt>maint</tt>) as well,
  setting up a tracking branch is recommended:
</p>
<pre>
$ git branch -t maint origin/maint
</pre>
<p>
  Subsequently, just use <tt>git pull</tt> which will sync both <tt>master</tt>
  and <tt>maint</tt> branches.
</p>
<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/#ml">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>
  The source tree contains a
  <a href="http://git.calcurse.org/calcurse.git/tree/doc/submitting-patches.txt">document</a>
  describing our preferences and general things you should take care of when
  submitting a patch to calcurse for the first time. A pre-built HTML version
  of that document can be found
  <a href="/files/submitting-patches.html">here</a>.
</p>
<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>

<h2 id="gs">Getting Started</h2>
<p>
  If you are interested in contributing to <tt>calcurse</tt> development, the
  following steps are good to start with:
</p>
<ul>
  <li>
    <a href="/support/#ml">Subscribe</a> to the mailing lists.
  </li>
  <li>
    <a href="#source">Pull in</a> and <a href="#build">build</a> the latest
    development source.
  </li>
  <li>
    Check the current
    <a href="http://bugs.calcurse.org/frs/open/">list of open feature
    requests</a>.
  </li>
  <li>
    Test and <a href="#patches">submit</a> your patches to <tt>misc at calcurse
    got org</tt>.
  </li>
</ul>

<h2 id="i8n">Translations</h2>
<p>
  We currently use
  <a href="http://transifex.net/projects/p/calcurse/">Transifex</a> to manage
  <tt>calcurse</tt> translations. Following languages are available:
</p>
<p>
  <img border="0" src="http://www.transifex.net/projects/p/calcurse/chart/image_png"/><br />
</p>
<p>
  To find out more about our translation workflow, check the <tt>calcurse
  i18n</tt> section in the manual. Translation contributions are highly
  appreciated!
</p>

<h2 id="stats">Statistics</h2>
<p>
  The following graphs have been generated using
  <a href="http://scm-pepper.sourceforge.net/">pepper</a>'s built-in reports:
</p>
<ul class="gallery">
  <li>
    <a href="/images/stats/loc.png" rel="lightbox[stats]">
      <img src="/images/stats/thumb/loc.png" alt="Lines of code">
      <span>Lines of code</span>
    </a>
  </li>
  <li>
    <a href="/images/stats/directories.png" rel="lightbox[stats]">
      <img src="/images/stats/thumb/directories.png" alt="Directory sizes">
      <span>Directory sizes</span>
    </a>
  </li>
  <li>
    <a href="/images/stats/commit_counts.png" rel="lightbox[stats]">
      <img src="/images/stats/thumb/commit_counts.png" alt="Commit counts">
      <span>Commit counts</span>
    </a>
  </li>
</ul>
<p style="clear:both;">
  The reports are currently regenerated manually and therefore might be
  slightly out of date at times.
</p>
    </div>
    <div id="footer">
      Copyright &copy; 2012-2013 <a href="/support/#devs">calcurse Development Team</a>.
      Licensed under the terms of the BSD License.
    </div>
  </body>
</html>