Browse Source

added Readme

Taco 1 year ago
parent
commit
e61662176d
1 changed files with 35 additions and 0 deletions
  1. 35 0
      Readme.md

+ 35 - 0
Readme.md

@@ -0,0 +1,35 @@
1
+# Design
2
+The docs directory contains high level concept designs in pdf format describing the overall ideas and design metaphors underpinning the interactive proof of concept.
3
+
4
+# Interactive proof of concept
5
+The proof of concept is developed as a set of code blocks using [(spac)emacs](http://spacemacs.org/) [org-mode](https://orgmode.org/), in the file entitlements.org.
6
+You can open and read the entitlements.org file in any text editor, but for the best readability and code blocks support you will need org-mode.
7
+
8
+The file 'entitlements.html' is the exported html result that you can use to interact with the proof of concept in the browser. 
9
+
10
+The file diff.xml is generated during evaluation of the code blocks and contains a random set of fake wallet profile data.
11
+Because the diff.xml needs to be read at runtime, use Firefox to open the entitlements.html from the filesystem. Chrome and safari will restrict access to the xml file without a web server, and prevent the poc from rendering.
12
+
13
+The file processing.js is a runtime library downloaded from [processingjs.org](http://processingjs.org);
14
+
15
+'You write code using the Processing language, include it in your web page, and Processing.js does the rest. It's not magic, but almost.'
16
+
17
+# Modifying the prototype
18
+
19
+Probably no need to do this, but for those who are adventurous...
20
+
21
+## emacs configuration
22
+The code blocks are written in javascript, ruby and processing (java). So if you want to evaluate the code blocks you need to configure emacs to include these in the active babel languages;
23
+
24
+``;; active Babel languages
25
+(org-babel-do-load-languages
26
+ 'org-babel-load-languages
27
+ '((ruby . t)
28
+   (js . t)
29
+   (processing . t)
30
+   (emacs-lisp . nil)))``
31
+
32
+And of course support for the programming languages themselves.
33
+In order to export to html, make sure to include the htmlize package in your configuration;
34
+
35
+``dotspacemacs-additional-packages '(htmlize)``