aboutsummaryrefslogtreecommitdiffhomepage
path: root/org/spine_info.org
diff options
context:
space:
mode:
Diffstat (limited to 'org/spine_info.org')
-rw-r--r--org/spine_info.org99
1 files changed, 54 insertions, 45 deletions
diff --git a/org/spine_info.org b/org/spine_info.org
index 7d09b92..b93242e 100644
--- a/org/spine_info.org
+++ b/org/spine_info.org
@@ -178,13 +178,11 @@ The default build tools used are dub with ldc2 (dub is also tested)
#+NAME: sisudoc_spine_readme_install_body_clone_h2
#+BEGIN_SRC markdown
-make a directory and clone the sisudoc-spine project-heading
+make a directory and clone the sisudoc-spine project
#+END_SRC
#+NAME: sisudoc_spine_readme_install_body_clone
#+BEGIN_SRC markdown
-# make a directory and clone the sisudoc-spine project
-
mkdir ~/git.sisudoc
cd ~/git.sisudoc
@@ -193,6 +191,9 @@ make a directory and clone the sisudoc-spine project-heading
git clone git://git.sisudoc.org/markup/sisudoc-spine-samples
such a relative directory layout will be assumed in the examples that provided
+
+all work in this installation of and use of sisudoc-spine will take place in the
+directory: sisudoc-spine
#+END_SRC
#+NAME: sisudoc_spine_readme_install_body_build_h2
@@ -202,17 +203,27 @@ build sisudoc-spine
#+NAME: sisudoc_spine_readme_install_body_build
#+BEGIN_SRC markdown
+NOTE all actions to build sisudoc-spine are taken within the directory
+sisudoc-spine
+
+cd sisudoc-spine
+
## directly with dub
### ldc2
+ # on nix (get dependencies by setting your development environment):
+ nix develop ".#dsh-nixpkgs-ldc-dub" --print-build-logs -c zsh
+ dub run --compiler=ldmd2 --config=ldmd2 --combined --skip-registry=all
dub --compiler=ldmd2 --config=ldmd2
- dub --verbose --compiler=ldmd2 -color --config=ldmd2
+ dub run --compiler=ldc2 --config=ldc2 --combined --skip-registry=all
dub --compiler=ldc2 --config=ldc2
- dub --verbose --compiler=ldc2 -color --config=ldc2
### dmd
+ # on nix (get dependencies by setting your development environment):
+ nix develop ".#dsh-nixpkgs-dmd-dub" --print-build-logs -c zsh
+ dub run --compiler=dmd --config=dmd --combined --skip-registry=all
dub --compiler=dmd --config=dmd
## with make
@@ -229,12 +240,10 @@ build sisudoc-spine
### ldc2
- nix develop ".#dsh-nixpkgs-ldc-dub" --print-build-logs -c zsh
nix build ".#spine-nixpkgs-ldc" --print-build-logs
### dmd
- nix develop ".#dsh-nixpkgs-dmd-dub" --print-build-logs -c zsh
nix build ".#spine-nixpkgs-dmd" --print-build-logs
## the Meson build system was used briefly
@@ -531,44 +540,6 @@ at the time of writing this provides the following output:
<<sisudoc_spine_readme_examples_create_db_and_search_form_text>>
#+END_SRC
-*** env exports
-
-#+NAME: sisudoc_spine_readme_env_exports
-#+BEGIN_SRC markdown
-These examples assume the file layout suggested in cloning the git.sisudoc.org
-repository, i.e. that the directories sisudoc-spine and sisudoc-spine-samples
-are next to each other on a directory tree. Assuming this to be the case, you
-may wish to set the following exports with adjustments accoring to your specific
-needs for these examples.
-
-# ❯❯ set spine binary location:
-export SpineBIN=./result/bin/spine
-# ❯❯ nix builds spine binary:
-#export SpineBIN=./result/bin/spine
-# ❯❯ dub builds spine binary (name depends on build, check):
-#export SpineBIN=./bin/spine
-#export SpineBIN=./bin/spine-ldc
-#export SpineBIN=./bin/spine-dmd
-# ❯❯ location of source files:
-export SpineDOC=../sisudoc-spine-samples
-# ❯❯ location of source files pod:
-export SpinePOD=${SpineDOC}/markup/pod
-# ❯❯ sisudoc-spine output processing path:
-export SpineOUT=./OUTPUT_TEST_sisudocSpine
-# ❯❯ sisudoc-spine output processing path (web server e.g.):
-#export SpineOUT=/srv/www/spine
-export SpineSearchActionLocal='http://localhost/spine_search'
-export SpineSearchActionRemote='https://sisudoc.org/spine_search'
-# ❯❯ path configured for cgi search form:
-export SpineCGIform='spine_search'
-# ❯❯ search form db name:
-export SpineSQLdb='spine.search.db'
-# ❯❯ configuration cgi search form path:
-#export SpineCGIbin=/var/www/cgi/cgi-bin
-# ❯❯ configuration db path:
-#export SpineDBpath=/var/www/sqlite
-#+END_SRC
-
*** text body md
#+NAME: sisudoc_spine_readme_examples_md
@@ -611,6 +582,44 @@ export SpineSQLdb='spine.search.db'
<<sisudoc_spine_readme_examples_create_db_and_search_form_text>>
#+END_SRC
+*** env exports
+
+#+NAME: sisudoc_spine_readme_env_exports
+#+BEGIN_SRC markdown
+These examples assume the file layout suggested in cloning the git.sisudoc.org
+repository, i.e. that the directories sisudoc-spine and sisudoc-spine-samples
+are next to each other on a directory tree. Assuming this to be the case, you
+may wish to set the following exports with adjustments accoring to your specific
+needs for these examples.
+
+# ❯❯ set spine binary location:
+export SpineBIN=./result/bin/spine
+# ❯❯ nix builds spine binary:
+#export SpineBIN=./result/bin/spine
+# ❯❯ dub builds spine binary (name depends on build, check):
+#export SpineBIN=./bin/spine
+#export SpineBIN=./bin/spine-ldc
+#export SpineBIN=./bin/spine-dmd
+# ❯❯ location of source files:
+export SpineDOC=../sisudoc-spine-samples
+# ❯❯ location of source files pod:
+export SpinePOD=${SpineDOC}/markup/pod
+# ❯❯ sisudoc-spine output processing path:
+export SpineOUT=./OUTPUT_TEST_sisudocSpine
+# ❯❯ sisudoc-spine output processing path (web server e.g.):
+#export SpineOUT=/srv/www/spine
+export SpineSearchActionLocal='http://localhost/spine_search'
+export SpineSearchActionRemote='https://sisudoc.org/spine_search'
+# ❯❯ path configured for cgi search form:
+export SpineCGIform='spine_search'
+# ❯❯ search form db name:
+export SpineSQLdb='spine.search.db'
+# ❯❯ configuration cgi search form path:
+#export SpineCGIbin=/var/www/cgi/cgi-bin
+# ❯❯ configuration db path:
+#export SpineDBpath=/var/www/sqlite
+#+END_SRC
+
*** text body content
#+NAME: sisudoc_spine_readme_examples_curate_text