aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormjfernez <mjf@mjfer.net>2022-03-13 14:56:45 -0400
committermjfernez <mjf@mjfer.net>2022-03-13 15:16:12 -0400
commit150b9695fdb0ebfeca0f8d5b268249bea46ea3f3 (patch)
treefb5be19c2bd4d9d9f4b7ef961872bccb5f78fcf9
parent5589754533aab9b7edbdc41cc13c2cd189aa3c26 (diff)
downloadezcms-150b9695fdb0ebfeca0f8d5b268249bea46ea3f3.tar.gz
README updates
Adds changes to readme from mjfer.net branch. Fixes some grammar, clarifies how to use git.
-rw-r--r--README.md31
1 files changed, 26 insertions, 5 deletions
diff --git a/README.md b/README.md
index bd3f1e6..fca29ad 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,9 @@
## Requirements
-Python 3.7+
+- Python 3.7+
+- git (for keeping track of your site updates)
## Huh/What/Why?
@@ -27,7 +28,7 @@ https://neocities.org/
It's easy to get a simple static site going there and it's totally
free, but it lacks server side scripting as far as I know.
-I did used to have wordpress blog, but I got bored of maintaining it. I
+I used to have wordpress blog, but I got bored of maintaining it. I
felt like making something from scratch might make me more invested in
making an interesting site.
@@ -175,11 +176,12 @@ replace the HTML with your own license (or none), by editing
`templates/site/license.html`
-### RSS and Caching
+### RSS
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
-them to the omit file from the perspective of the site dir.
+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,6 +191,25 @@ or for files run under 'site'
`home.html`
+You can either continue to use the cloned `ezcms` repo as your git repo
+and `git add` and `git commit` files added to the `templates/site/`
+directory. Or 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
There are a few special directories linked that are needed to