aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormjfernez <mjf@mjfer.net>2022-03-10 18:34:22 -0500
committermjfernez <mjf@mjfer.net>2022-03-10 18:34:22 -0500
commitc0be486968fe3d375d1f408eae7f954e1f5f82fc (patch)
treed5fac6cc4a8d129275bde64498b0e6662d4d47fe /README.md
parentf335ff5265a96fdc0b9e0e9d8e4384f866de4e19 (diff)
downloadezcms-c0be486968fe3d375d1f408eae7f954e1f5f82fc.tar.gz
Fixes RSS issues. Changes time tracking to git
This commit primarily changes the code base to base the file last modified time on the output of "git log". This adds dateutil and git itself as a dependency, but those are pretty common... This also fixes some minor issues including: - missing / between mjfer.net and the URI - README up to date with latest changes - linting
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 19 insertions, 7 deletions
diff --git a/README.md b/README.md
index e376da9..56bc3f2 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
## Requirements
Python 3.7+
-
+git (for RSS generation)
## Huh/What/Why?
@@ -178,7 +178,8 @@ replace the HTML with your own license (or none), by editing
### RSS and Caching
This app comes packaged with an auto-RSS generator that makes a feed
-based on the files in the site directory. You can omit files by adding
+based on the files in the site directory, presuming you use git to keep
+track of your files. You can omit files by adding
them to the omit file from the perspective of the site dir.
For example:
@@ -189,11 +190,22 @@ or for files run under 'site'
`home.html`
-You can also make use of the Flask-Caching module to optimize your
-site's perfomance. There are many options available and to be honest, I don't know much about them, but a simple cache of 5 minutes is provided by default. You'll want to read the
- [Flask-Caching
-docs](https://flask-caching.readthedocs.io/en/latest/index.html)
- before experimenting.
+You can make your site into a local git repo with:
+
+```bash
+$ cd ./templates/site
+$ rm -rf *
+$ git init
+<make some files>
+$ git add .
+$ git commit -m "new update"
+```
+
+Alternatively, you can make a new git repo elsewhere and add it to the
+main project as a submodule.
+
+See [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
+for more on submodules
### Other Tips