From 129f969435b836ec6e8e44a569b7a034602742a5 Mon Sep 17 00:00:00 2001 From: Martin Blais Date: Tue, 15 Jul 2014 19:52:38 -0400 Subject: [PATCH] Updated README and home page with links and deleted old install documentation. You should use the install file on Google Docs now (http://furius.ca/beancount/doc/install). --- Makefile | 2 +- README | 81 ++++++++---------------------------- index.html | 94 +++++++++++++----------------------------- install/README.install | 65 ----------------------------- install/installdeps.sh | 65 ----------------------------- 5 files changed, 47 insertions(+), 260 deletions(-) delete mode 100644 install/README.install delete mode 100755 install/installdeps.sh diff --git a/Makefile b/Makefile index 9235a94ed..4e529cc8f 100755 --- a/Makefile +++ b/Makefile @@ -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. diff --git a/README b/README index 8047d219e..1a266662b 100644 --- a/README +++ b/README @@ -1,16 +1,15 @@ ======================================================== - 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 @@ -18,86 +17,42 @@ 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 `_ -- `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 `_, 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. -`_ +__ 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 diff --git a/index.html b/index.html index 0cbb6bd34..d58639f2e 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ -beancount: Double-Entry Accounting from Text Input +beancount: Double-Entry Accounting from Text Files @@ -14,96 +14,58 @@ -
-

beancount: Double-Entry Accounting from Text Input

+
+

beancount: Double-Entry Accounting from Text Files

+3 Download & Installation +4 Filing Bugs +5 Copyright and License +6 Author -->
-

Description

+

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

- +

Documentation

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, 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:

+
+

Download & Installation

+

You can obtain the source code from a Mercurial repository on my server or from +BitBucket:

-http://bitbucket.org/blais/beancount/
-

Download it like this:

-
-hg clone http://hg.furius.ca/public/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.

-

Click here for generic download instructions for all my projects.

+
+
http://hg.furius.ca/public/beancount/
+
https://bitbucket.org/blais/beancount/
-
-

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)
    • -
+ +

See the Installing Beancount document for more details.

-
-

Installation

-

Installation instructions are under beancount/install.

+
+

Filing Bugs

+

Tickets can be filed at on the BitBucket project page:

+
+https://bitbucket.org/blais/beancount/issues