aboutsummaryrefslogtreecommitdiffhomepage
path: root/org
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2024-05-22 16:26:31 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2024-05-22 16:26:31 -0400
commitd33213ed855ba50e0a0b789a934d5ad3aadef17b (patch)
tree00a133edb64f3a064c60d82630b651e038631318 /org
parentmarkup samples, doc headers: urls & yaml style (diff)
README, added to note on installation using nix
Diffstat (limited to 'org')
-rw-r--r--org/spine_info.org30
1 files changed, 22 insertions, 8 deletions
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):