29 lines
918 B
Markdown
29 lines
918 B
Markdown
# Welcome
|
|
SFIS -- A simple cross-platform Static File Index System
|
|
[Website](https://sfis.wangzhiyu.ga/)
|
|
[Preview](https://sfis-eg.vercel.app)
|
|
## Quick Start
|
|
1. Install Python 3.x from python.org
|
|
2. Install Package from Internet
|
|
``` bash
|
|
python3 -m pip install Markdown pyyaml fire
|
|
```
|
|
If it doesn't work, try:
|
|
``` bash
|
|
python -m pip install Markdown pyyaml fire
|
|
```
|
|
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! |