From 7907a2398017b3aabc408d2d00e641089af75cea Mon Sep 17 00:00:00 2001 From: kbenestad Date: Tue, 21 Apr 2026 10:29:23 +0700 Subject: [PATCH] Add installation section to README Added installation instructions for MD-CMS. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index ad35c38..15cc8e7 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,20 @@ MD-CMS lets you write and publish a website entirely in markdown. Drop your `.md --- +## Installation + +1) Download the latest [release](https://github.com/kbenestad/mdcms/releases). + - The contents of `mdcms-vNNN.zip` and `mdcms.zip` are identical. Choose whatever suits your preference. +3) Unzip the content in your project directory. +3) Make necessary changes to `config.yml` and add pages to `pages/`. *Please note: Links to other pages are in the form `pages/pagename.md`.* +4) Open the terminal in your project directory, and: + - Open MDCMS.py with `python3 mdcms.py`. + - Select option 3 to generate a `nav.yml` and `search.json` file. + - Open `nav.yml` in your text editor and make sure that the section and title names are correct. + - Once you're satisfied, you're ready to upload the content of `website/`. If you need a ZIP file, return to the terminal and select option 1. + +--- + ## How it works MD-CMS has two parts: