aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
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