From c548ab747b62c529f9fb5361d9f5f55384b1dc9d Mon Sep 17 00:00:00 2001 From: Wang Zhiyu Date: Thu, 8 Jun 2023 00:52:26 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- server/README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/server/README.md b/server/README.md index f4382df..7ab1d2b 100644 --- a/server/README.md +++ b/server/README.md @@ -1,29 +1,25 @@ # Welcome -SFIS -- A simple cross-platform Static File Index System -[Website](https://sfis.wangzhiyu.ga/) -[Preview](https://sfis-eg.vercel.app) +SFIS -- A simple cross-platform Static File Indexing Software +[Website](https://sfis.ga/) +[Preview](https://sample.sfis.ga) ## Quick Start -1. Install Python 3.x from python.org -2. Install Package from Internet +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 ``` -If it doesn't work, try: +3. Clone Source Code +Git should be installed first. +Run the command in shell (bash or cmd) ``` bash -python -m pip install Markdown pyyaml fire +git clone https://github.com/david-ajax/sfis/ && cd sfis ``` -3. Clone Code -GUI Way: - Click "Code" button, download the ZIP package and extract it to run it. -CLI Way: - You should install git or gitbash first. - Run the command in terminal(bash or cmd) - ``` bash - git clone https://github.com/david-ajax/sfis/ && cd sfis - ``` 4. Run Code ``` bash python3 main.py ``` -Put your files in "files" folder. -Upload project root folder to your static cloud storage space(such as GitHub or Vercel) and builds the index file, you can get a useful personal static cloud space now! \ No newline at end of file +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 \ No newline at end of file