25 lines
718 B
Markdown
25 lines
718 B
Markdown
# Welcome
|
|
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 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 |