From 89f5861c2b6f47c123d27504e12b5911f1252dcd Mon Sep 17 00:00:00 2001 From: Ruben Rodriguez Date: Wed, 1 Feb 2023 15:26:16 +0100 Subject: [PATCH] Updated install and usage instructions --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 34feec4..5c5f6ac 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ -# Installation (using python-pip + virtualenv) +# Installation (using virtualenv) - virtualenv ~/virtualenvs/pelican - cd ~/virtualenvs/pelican - source bin/activate +For Trisquel users: Note that although virtualenv and pip are free software, they are not in the Trisquel repositories because these don't include third-party package repositories. You can install python3-pip and python3-virtualenv from packages.ubuntu.com using the matching upstream version of Ubuntu for the Trisquel release you use (For Trisquel 10 nabia use "Focal" packages, For Trisquel 11 aramo use "Jammy" packages. - python -m pip install pelican[markdown] - python -m pip install pelican-liquid-tags - python -m pip install pelican-image-process + git clone git@vcs.fsf.org:financial-reports.git + virtualenv financial-reports + . bin/activate -Requires font droid sans for svg generation + pip install pelican[markdown] + pip install pelican-liquid-tags + pip install pelican-image-process + pip install matplotlib + + cp plugins/* ./lib/python*/site-packages/pelican/plugins/liquid_tags + +# Usage notes + +* Table headers have two '||' if the right-side column is empty (the default in our theme). You can have text on both columns of the header by using "foo | bar" as in "Expenses | Dollars" +* Images don't need to be scaled down, pelican does it automatically. Include the large resolution versionJPG of the image. +* Logos should be svg if possible. If they are png, the background should be transparent. # License information -- 2.25.1