From 57ebd59233cf81c51481efa5ffbc23a260e5f7b5 Mon Sep 17 00:00:00 2001 From: Alex Cabal Date: Mon, 1 Jan 2024 22:31:09 -0600 Subject: [PATCH] Update README to correctly install the SE toolset as a library --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ed322a1..91d2030f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Installation -PHP 7+ is required. +PHP 8+ is required. ## Installing on Ubuntu 22.04 @@ -46,7 +46,15 @@ If everything went well you should now be able to open your web browser and visi # First, install the SE toolset, which will make the `se build` command-line executable available to the `deploy-ebook-to-www` script: # https://standardebooks.org/tools -# Once the toolset is installed, clone a book and deploy it to your local SE site: +# Install the SE toolset as a library so we can use it in some automated scripts. +pip install standardebooks + +# The `se` command must be in your $PATH, but installing it via `pip` might not do that automatically. +# If `which se` doesn't say anything, then either add the `pip` installation of the `se` executable to your $PATH manually, # or install it again using `pipx`; this will create a duplicate installation, +# but it will also install it in your $PATH for you: +pipx install standardebooks + +# Once the toolset is installed and in your $PATH, clone a book and deploy it to your local SE site: mkdir /standardebooks.org/ebooks/ cd /standardebooks.org/ebooks/ git clone --bare https://github.com/standardebooks/david-lindsay_a-voyage-to-arcturus