README, added to note on installation using nix

3 files changed, 55 insertions, 35 deletions

diff --git a/README b/README
index 8e317f9..7ec11cd 100644
--- a/README
+++ b/README
@@ -75,29 +75,6 @@ or
 
 spine --source --pod [.sst document name]
 
-* sisudoc-spine pod structure
-
-pod (directory may contain multiple documents)
- └── the_wealth_of_networks.yochai_benkler
-     ├── conf
-     │   └── sisu_document_make
-     ├── media
-     │   ├── image
-     │   │   ├── won_benkler_2_1.png
-     │   │   ├── won_benkler_6_1.png
-     │   │   ├── won_benkler_7_1.png
-     │   │   ├── won_benkler_7_2.png
-     │   │   ├── won_benkler_7_3a.png
-     │   │   ├── won_benkler_7_3b.png
-     │   │   ├── won_benkler_7_4.png
-     │   │   ├── won_benkler_7_5.png
-     │   │   ├── won_benkler_7_6.png
-     │   │   └── won_benkler_9_1.png
-     │   └── text
-     │       └── en
-     │           └── the_wealth_of_networks.yochai_benkler.sst
-     └── pod.manifest
-
 * Installation, Compilation
 
 These are document markup samples for the program sisudoc-spine and as such
@@ -125,13 +102,16 @@ sisudoc-spine to generate document output see the README in that directory.
 
   cd sisudoc-spine-samples
 
+*** build using nix flakes on linux (binary in ./result/bin)
+
+
 If you happen to be using Nix or NixOS (x86_64-linux so far), you can install
 sisudoc-spine from the flake.nix file provided in this (sisudoc-spine-samples)
 directory tree, without first cloning sisudoc-spine (the flake will fetch and
 build from online source).
 
-NOTE all actions to build sisudoc-spine are taken within the directory
-sisudoc-spine-samples
+NOTE all actions to build sisudoc-spine under current discusson are taken within
+the directory sisudoc-spine-samples
 
 choose one of the following nix flake runes to build sisudoc-spine (here in the
 sisudoc-spine-samples directory tree):
@@ -147,6 +127,29 @@ the result which can be used to generate content should be available in:
 What you do with these is run sisudoc-spine (now available loocally) against the
 document source to get the desired output.
 
+* sisudoc-spine pod structure
+
+pod (directory may contain multiple documents)
+ └── the_wealth_of_networks.yochai_benkler
+     ├── conf
+     │   └── sisu_document_make
+     ├── media
+     │   ├── image
+     │   │   ├── won_benkler_2_1.png
+     │   │   ├── won_benkler_6_1.png
+     │   │   ├── won_benkler_7_1.png
+     │   │   ├── won_benkler_7_2.png
+     │   │   ├── won_benkler_7_3a.png
+     │   │   ├── won_benkler_7_3b.png
+     │   │   ├── won_benkler_7_4.png
+     │   │   ├── won_benkler_7_5.png
+     │   │   ├── won_benkler_7_6.png
+     │   │   └── won_benkler_9_1.png
+     │   └── text
+     │       └── en
+     │           └── the_wealth_of_networks.yochai_benkler.sst
+     └── pod.manifest
+
 * Document processing examples
 
 e.g.:
diff --git a/README.md b/README.md
index cf51ba5..7b7f43e 100644
--- a/README.md
+++ b/README.md
@@ -85,13 +85,16 @@ sisudoc-spine to generate document output see the README in that directory.
 
   cd sisudoc-spine-samples
 
+### build using nix flakes on linux (binary in ./result/bin)
+
+
 If you happen to be using Nix or NixOS (x86_64-linux so far), you can install
 sisudoc-spine from the flake.nix file provided in this (sisudoc-spine-samples)
 directory tree, without first cloning sisudoc-spine (the flake will fetch and
 build from online source).
 
-NOTE all actions to build sisudoc-spine are taken within the directory
-sisudoc-spine-samples
+NOTE all actions to build sisudoc-spine under current discusson are taken within
+the directory sisudoc-spine-samples
 
 choose one of the following nix flake runes to build sisudoc-spine (here in the
 sisudoc-spine-samples directory tree):
diff --git a/org/spine_info.org b/org/spine_info.org
index 9756354..cc107d4 100644
--- a/org/spine_info.org
+++ b/org/spine_info.org
@@ -34,14 +34,18 @@
 
 <<sisudoc_spine_README_summary>>
 
-,* sisudoc-spine pod structure
-
-<<sisudoc_spine_pod_dir_structure>>
-
 ,* Installation, Compilation
 
 <<sisudoc_spine_README_install_summary>>
 
+,*** build using nix flakes on linux (binary in ./result/bin)
+
+<<sisudoc_spine_README_install_build_using_nix_flakes>>
+
+,* sisudoc-spine pod structure
+
+<<sisudoc_spine_pod_dir_structure>>
+
 ,* Document processing examples
 
 <<sisudoc_spine_README_commands>>
@@ -50,7 +54,7 @@
 **** org header
 
 #+NAME: sisudoc_spine_README_header_org
-#+BEGIN_SRC text
+#+BEGIN_SRC org
 -*- mode: org -*-
 ,#+TITLE:       spine (sisudoc) (project) README
 ,#+DESCRIPTION: README for spine
@@ -84,6 +88,10 @@
 
 <<sisudoc_spine_README_install_summary>>
 
+### build using nix flakes on linux (binary in ./result/bin)
+
+<<sisudoc_spine_README_install_build_using_nix_flakes>>
+
 # sisudoc-spine pod structure
 
 <<sisudoc_spine_pod_dir_structure>>
@@ -93,7 +101,7 @@
 <<sisudoc_spine_README_commands>>
 #+END_SRC
 
-** project header
+** project yaml header
 
 #+NAME: sisudoc_spine_README_project_header_info
 #+BEGIN_SRC yaml
@@ -215,14 +223,20 @@ sisudoc-spine-samples provides markup samples for sisudoc-spine to use
 sisudoc-spine to generate document output see the README in that directory.
 
   cd sisudoc-spine-samples
+#+END_SRC
+
+**** install build project using nix flakes
+
+#+NAME: sisudoc_spine_README_install_build_using_nix_flakes
+#+BEGIN_SRC text
 
 If you happen to be using Nix or NixOS (x86_64-linux so far), you can install
 sisudoc-spine from the flake.nix file provided in this (sisudoc-spine-samples)
 directory tree, without first cloning sisudoc-spine (the flake will fetch and
 build from online source).
 
-NOTE all actions to build sisudoc-spine are taken within the directory
-sisudoc-spine-samples
+NOTE all actions to build sisudoc-spine under current discusson are taken within
+the directory sisudoc-spine-samples
 
 choose one of the following nix flake runes to build sisudoc-spine (here in the
 sisudoc-spine-samples directory tree):