Skip to content

Commit

Permalink
Updated README and home page with links and deleted old install docum…
Browse files Browse the repository at this point in the history 
…entation. You should use the install file on Google Docs now (http://furius.ca/beancount/doc/install).
  • Loading branch information
@blais
blais committed Jul 15, 2014
1 parent 80eaef4 commit 129f969
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 260 deletions.
2 changes: 1 addition & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ grind:
valgrind --leak-check=full /usr/local/bin/python3 bean-sandbox $(INPUT)

# Regenerate the website.
html:
html docs:
projects docs beancount

# Compute and plot inter-module dependencies.
Expand Down
81 changes: 18 additions & 63 deletions README
View file
Original file line number Diff line number Diff line change
@@ -1,103 +1,58 @@
========================================================
beancount: Double-Entry Accounting from Text Input
beancount: Double-Entry Accounting from Text Files
========================================================

.. contents::
..
1 Description
2 Documentation
3 Download
4 Dependencies
5 Installation
6 Copyright and License
7 Author
3 Download & Installation
4 Filing Bugs
5 Copyright and License
6 Author


Description
===========

A double-entry bookkeeping computer language that lets you define financial
transaction records in a text file, read them in memory, generate a variety of
reports from them, and provides a web interface. This project

Beancount 2.0-beta is the only beancount as of Summer 2013. It's a full rewrite
of version 1.0, very stable, and I'm using only this version now, it is
maintained, and I have 7-8 years worth of my personal data relying on it and use
it every week or two in many ways. This is an actively developed project; it
works.
reports from them, and provides a web interface.


Documentation
=============

- `CHANGES <CHANGES>`_
- `TODO <TODO>`_

Documentation lives on Google Docs. You can find an index to all the available
documents here:

http://furius.ca/beancount/doc/index

(IMPORTANT NOTE [2014-07-13]: Documentation is being written this summer. You
may find the current state of the documentation in-progress. I'm focusing hard
on this and hope to be done before September 2014.)

Discussions about Beancount occur on the `Ledger mailing-list
<https://groups.google.com/forum/#!forum/ledger-cli>`_, which has become the *de
facto* discussion group for all command-line accounting softwares.


Download
========

You can obtain the source code from a Mercurial repository, found at:

http://hg.furius.ca/public/beancount/

This is the authoritative location for the latest version. There is also a
mirror at bitbucket that has a snazzier web interface, that I try to regularly
push changes to:

http://bitbucket.org/blais/beancount/
Download & Installation
=======================

Download it like this:
You can obtain the source code from a Mercurial repository on my server or from
BitBucket:

hg clone http://hg.furius.ca/public/beancount/
| http://hg.furius.ca/public/beancount/
| https://bitbucket.org/blais/beancount/

I don't use github. github clones that can be found in the wild are probably out
of date, you should clone from the URL above.
See the `Installing Beancount`__ document for more details.

`Click here for generic download instructions for all my projects.
</web-furius/downloading.html>`_
__ http://furius.ca/beancount/doc/install


Dependencies
============

For users:

- Python 3.3 or above.
- cdecimal (optional but strongly suggested, for performance)
- Bottle (a tiny web server, pure Python)
- wget (to bake reports to a zip file)

You can install some of those using pip3 (cdecimal appears to require an
otherwise straightforward install from source).

For developers:

- GNU flex and bison (to build the parser)
- lxml
- nosetests (to run the unit tests)
- pylint >=1.2 (to run the linter)
- snakefood (for unused imports check)
- graphviz (for graphing module dependencies)

Filing Bugs
===========

Installation
============
Tickets can be filed at on the BitBucket project page:

Installation instructions are under beancount/install.
https://bitbucket.org/blais/beancount/issues


Copyright and License
Expand Down
94 changes: 28 additions & 66 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta name="generator" content="Docutils 0.10: http://docutils.sourceforge.net/" />
<title>beancount: Double-Entry Accounting from Text Input</title>
<title>beancount: Double-Entry Accounting from Text Files</title>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body>
Expand All @@ -14,96 +14,58 @@

</div>

<div class="document" id="beancount-double-entry-accounting-from-text-input">
<h1 class="title">beancount: Double-Entry Accounting from Text Input</h1>
<div class="document" id="beancount-double-entry-accounting-from-text-files">
<h1 class="title">beancount: Double-Entry Accounting from Text Files</h1>

<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#description" id="id1">Description</a></li>
<li><a class="reference internal" href="#documentation" id="id2">Documentation</a></li>
<li><a class="reference internal" href="#download" id="id3">Download</a></li>
<li><a class="reference internal" href="#dependencies" id="id4">Dependencies</a></li>
<li><a class="reference internal" href="#installation" id="id5">Installation</a></li>
<li><a class="reference internal" href="#description" id="id2">Description</a></li>
<li><a class="reference internal" href="#documentation" id="id3">Documentation</a></li>
<li><a class="reference internal" href="#download-installation" id="id4">Download &amp; Installation</a></li>
<li><a class="reference internal" href="#filing-bugs" id="id5">Filing Bugs</a></li>
<li><a class="reference internal" href="#copyright-and-license" id="id6">Copyright and License</a></li>
<li><a class="reference internal" href="#author" id="id7">Author</a></li>
</ul>
</div>
<!-- 1 Description
2 Documentation
3 Download
4 Dependencies
5 Installation
6 Copyright and License
7 Author -->
3 Download & Installation
4 Filing Bugs
5 Copyright and License
6 Author -->
<div class="section" id="description">
<h1><a class="toc-backref" href="#id1">Description</a></h1>
<h1><a class="toc-backref" href="#id2">Description</a></h1>
<p>A double-entry bookkeeping computer language that lets you define financial
transaction records in a text file, read them in memory, generate a variety of
reports from them, and provides a web interface. This project</p>
<p>Beancount 2.0-beta is the only beancount as of Summer 2013. It's a full rewrite
of version 1.0, very stable, and I'm using only this version now, it is
maintained, and I have 7-8 years worth of my personal data relying on it and use
it every week or two in many ways. This is an actively developed project; it
works.</p>
reports from them, and provides a web interface.</p>
</div>
<div class="section" id="documentation">
<h1><a class="toc-backref" href="#id2">Documentation</a></h1>
<ul class="simple">
<li><a class="reference external" href="CHANGES">CHANGES</a></li>
<li><a class="reference external" href="TODO">TODO</a></li>
</ul>
<h1><a class="toc-backref" href="#id3">Documentation</a></h1>
<p>Documentation lives on Google Docs. You can find an index to all the available
documents here:</p>
<blockquote>
<a class="reference external" href="http://furius.ca/beancount/doc/index">http://furius.ca/beancount/doc/index</a></blockquote>
<p>(IMPORTANT NOTE [2014-07-13]: Documentation is being written this summer. You
may find the current state of the documentation in-progress. I'm focusing hard
on this and hope to be done before September 2014.)</p>
<p>Discussions about Beancount occur on the <a class="reference external" href="https://groups.google.com/forum/#!forum/ledger-cli">Ledger mailing-list</a>, which has become the <em>de
facto</em> discussion group for all command-line accounting softwares.</p>
</div>
<div class="section" id="download">
<h1><a class="toc-backref" href="#id3">Download</a></h1>
<p>You can obtain the source code from a Mercurial repository, found at:</p>
<blockquote>
<a class="reference external" href="http://hg.furius.ca/public/beancount/">http://hg.furius.ca/public/beancount/</a></blockquote>
<p>This is the authoritative location for the latest version. There is also a
mirror at bitbucket that has a snazzier web interface, that I try to regularly
push changes to:</p>
<div class="section" id="download-installation">
<h1><a class="toc-backref" href="#id4">Download &amp; Installation</a></h1>
<p>You can obtain the source code from a Mercurial repository on my server or from
BitBucket:</p>
<blockquote>
<a class="reference external" href="http://bitbucket.org/blais/beancount/">http://bitbucket.org/blais/beancount/</a></blockquote>
<p>Download it like this:</p>
<blockquote>
hg clone <a class="reference external" href="http://hg.furius.ca/public/beancount/">http://hg.furius.ca/public/beancount/</a></blockquote>
<p>I don't use github. github clones that can be found in the wild are probably out
of date, you should clone from the URL above.</p>
<p><a class="reference external" href="/web-furius/downloading.html">Click here for generic download instructions for all my projects.</a></p>
<div class="line-block">
<div class="line"><a class="reference external" href="http://hg.furius.ca/public/beancount/">http://hg.furius.ca/public/beancount/</a></div>
<div class="line"><a class="reference external" href="https://bitbucket.org/blais/beancount/">https://bitbucket.org/blais/beancount/</a></div>
</div>
<div class="section" id="dependencies">
<h1><a class="toc-backref" href="#id4">Dependencies</a></h1>
<p>For users:</p>
<ul class="simple">
<li>Python 3.3 or above.</li>
<li>cdecimal (optional but strongly suggested, for performance)</li>
<li>Bottle (a tiny web server, pure Python)</li>
<li>wget (to bake reports to a zip file)</li>
</ul>
<p>You can install some of those using pip3 (cdecimal appears to require an
otherwise straightforward install from source).</p>
<p>For developers:</p>
<ul class="simple">
<li>GNU flex and bison (to build the parser)</li>
<li>lxml</li>
<li>nosetests (to run the unit tests)</li>
<li>pylint &gt;=1.2 (to run the linter)</li>
<li>snakefood (for unused imports check)</li>
<li>graphviz (for graphing module dependencies)</li>
</ul>
</blockquote>
<p>See the <a class="reference external" href="http://furius.ca/beancount/doc/install">Installing Beancount</a> document for more details.</p>
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#id5">Installation</a></h1>
<p>Installation instructions are under beancount/install.</p>
<div class="section" id="filing-bugs">
<h1><a class="toc-backref" href="#id5">Filing Bugs</a></h1>
<p>Tickets can be filed at on the BitBucket project page:</p>
<blockquote>
<a class="reference external" href="https://bitbucket.org/blais/beancount/issues">https://bitbucket.org/blais/beancount/issues</a></blockquote>
</div>
<div class="section" id="copyright-and-license">
<h1><a class="toc-backref" href="#id6">Copyright and License</a></h1>
Expand Down
65 changes: 0 additions & 65 deletions install/README.install
View file

This file was deleted.

65 changes: 0 additions & 65 deletions install/installdeps.sh
View file

This file was deleted.

0 comments on commit 129f969

Please sign in to comment.