diff options
| author | Ralph Amissah <ralph.amissah@gmail.com> | 2024-05-22 16:26:31 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph.amissah@gmail.com> | 2024-05-22 16:26:31 -0400 |
| commit | d33213ed855ba50e0a0b789a934d5ad3aadef17b (patch) | |
| tree | 00a133edb64f3a064c60d82630b651e038631318 /README | |
| parent | markup samples, doc headers: urls & yaml style (diff) | |
README, added to note on installation using nix
Diffstat (limited to 'README')
| -rw-r--r-- | README | 53 |
1 files changed, 28 insertions, 25 deletions
@@ -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.: |