Commits

Dan Connolly  committed 9633fff

elaborate README with motivation and dependencies

  • Participants
  • Parent commits 23053df

Comments (0)

Files changed (1)

File finjax/README.txt

-finjax -- web app acccess to gnucash financial data
+finjax -- web app access to gnucash financial data
 ===================================================
 
+Support for SQL storage in GnuCash__ 2.4.10 allows reuse of the data
+using Web technologies, without extensive study of the GnuCash source
+code (which is upwards of 10MB, compressed).
+
+__ http://gnucash.org/
+
+Pyramid__ is "a small, fast, down-to-earth Python web application
+development framework." Building a RESTful JSON API to the GnuCash
+data is straightforward using SQLAlchemy__ SQL toolkit, which is
+conveniently packaged in the `alchemy` scaffold__.
+
+__ http://docs.pylonsproject.org/projects/pyramid/en/1.3-branch/
+__ http://docs.sqlalchemy.org/
+__ http://docs.pylonsproject.org/projects/pyramid/en/1.3-branch/narr/project.html#scaffolds-included-with-pyramid
+
+Building a browser interface to the JSON data is straightforward
+with AngularJS__, a JavaScript framework with two-way databinding,
+
+__ http://docs.angularjs.org/
+
+
 Getting Started
 ---------------
 
 - cd <directory containing this file>
 
-- $venv/bin/python setup.py develop
+- `$venv/bin/python setup.py develop` to install dependencies
+  in your development environment.
 
-- $venv/bin/populate_finjax development.ini
+- `$venv/bin/populate_finjax development.ini` to initialize
+  the database. *I think this is not quite right.*
 
-- $venv/bin/pserve development.ini
-
+- `$venv/bin/pserve development.ini` to start the server;
+  it prints a web address at start-up; point your browser there.