likho/microblog.py
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

squash merge readme-update

Browse Source
This commit is contained in:
likho 2023-09-30 04:33:51 -07:00
parent ae6650c775
commit bf4c09b180
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,7 +5,7 @@ Simple and stylish text-to-html microblog generator.
## Requirements
python3 make dateutil toml curl pycurl urllib
python3 dateutil toml make curl pycurl urllib
* `dateutil`, `toml` are Python modules.
* `make` (optional), method for invoking the script.
@ -13,19 +13,21 @@ Simple and stylish text-to-html microblog generator.
### Usage
Send three arguments minimum to `python`. The fourth argument for an e-mail address is optional.
python microblog.py ./template.html ./content.txt
The resulting web page is outputted from standard output. Therefore:
python microblog.py ./template.html ./content.txt > result.html
Use a Makefile (or another script) to simplify invocation.
The following generates a sample page `result.html`.
cp example/Makefile .
make
Using `make` is uptional; it does the following within a new directory:
cp example/settings.toml ./settings.toml
cp example/timeline.css ./timeline.css
cp example/default.tpl ./template.tpl
cp example/demo.txt ./content.txt
python microblog.py ./template.tpl ./content.txt > result.html
This script generate a text file after operation.
* `updatedfiles.txt`, a list of files updated by the script for use in automated uploads.
## Configuration
@ -46,7 +48,7 @@ The content file is a plain text file of posts. Each post has two types of infor
Thu Mar 16 2:22:22 PM EDT 2022
I took these pictures.
./images/1.jpg ./images/2.jpg ./images/3.jpg
/images/1.jpg /images/2.jpg /images/3.jpg
@ -58,4 +60,4 @@ The content file is a plain text file of posts. Each post has two types of infor
This is a script I wrote for personal use. The output can be seen on [https://likho.neocities.org/microblog/index.html](https://likho.neocities.org/microblog/index.html). I figure someone else may want to use it for their own personal websites, so it is published.
It works for me and my workflow; therefore, it is simple and involves little lines of code. But I am still open to comments, questions, or suggetions.
It works for me and my workflow; therefore, it is simple and involves little lines of code. But I am still open to comments, questions, or suggestions.