ajax/SFIS
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Wang Zhiyu 2023-08-25 11:49:09 +08:00 committed by GitHub
parent c548ab747b
commit 62687a299e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -6,9 +6,24 @@ A Static File Indexing System
**Please do not use it until I removed these text** **Please do not use it until I removed these text**
# Usage # Quick Start
1. Install Python 3.x from python.org or pkg manager
1. Clone source code 2. Install Python Packages from Internet
2. Run Code ``` bash
3. Start a web server python3 -m pip install markdown pyyaml fire
4. Completed! ```
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