From 5334f48a7be29fa85266ca4bdc8cf427eca88ff0 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 9 Feb 2023 21:41:51 -0500 Subject: nixify, enable nix install sisu for use here - enable nix install sisu for use on document samples --- README | 41 ++++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 15 deletions(-) (limited to 'README') diff --git a/README b/README index b83a522..c7ce091 100644 --- a/README +++ b/README @@ -1,29 +1,40 @@ +-*- mode: org -*- + +* what is this + These are samples of documents for use by SiSU prepared with SiSU markup -markup samples in sisu-markup-samples are installed to -/usr/share/doc/markup-samples + +the current versions are contained in the sub-directory: + +./data/samples/current/en/ + +* To install sisu using nix (flake) + +nix flake update +nix flake show +nix build . --print-build-logs + +nix develop .#devShell --print-build-logs -c zsh + +* To run sisu against sisu-markup samples Output in multiple formats can be generated running SiSU against the markup -samples, e.g.: +samples, e.g. you could try: + +sisu -v --html ./data/samples/current/en/the_wealth_of_networks.yochai_benkler.sst +sisu -v --html --epub ./data/samples/current/en/the_wealth_of_networks.yochai_benkler.sst -sisu --html filename.sst -sisu --html --epub --pdf filename.sst +sisu --html ./data/samples/current/en/* see: - man sisu - - -On Debian: - -(a) the lines to add for the upstream archive in /etc/apt/sources.list are: - deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free +* On Debian -(b) this package is placed in non-free, as the documents are released under the +(a) this package is placed in non-free, as the documents are released under the author or original publisher's license, and the substantive texts of the document is to be kept un-altered, which falls outside the Debian Free Software Guidelines -(c) this package would be placed in /usr/share/doc/sisu-markup-samples +(b) this package would be placed in /usr/share/doc/sisu-markup-samples as reference material on how to markup documents -- cgit v1.2.3