From 62687a299e9a3f2ce77698eba4bfad3dbe7eee08 Mon Sep 17 00:00:00 2001 From: Wang Zhiyu Date: Fri, 25 Aug 2023 11:49:09 +0800 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 17c11d2..36ec931 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,24 @@ A Static File Indexing System **Please do not use it until I removed these text** -# Usage - -1. Clone source code -2. Run Code -3. Start a web server -4. Completed! +# Quick Start +1. Install Python 3.x from python.org or pkg manager +2. Install Python Packages from Internet +``` bash +python3 -m pip install markdown pyyaml fire +``` +3. Clone Source Code +Git should be installed first. +Run the command in shell (bash or cmd) +``` bash +git clone https://github.com/david-ajax/sfis/ && cd sfis +``` +4. Run Code +``` bash +python3 main.py +``` +HTML files should be generated in the folder. +Try to move the folder into a webserver. +Redeploy to update static web files after putting your files in "files" folder. +## Serverless Deploy +todo