working
This commit is contained in:
parent
feefd59b80
commit
1d6f58ab8b
6 changed files with 98 additions and 1 deletions
17
README.md
17
README.md
|
|
@ -4,10 +4,27 @@ Static site generator for sharing self-hosted service information.
|
|||
|
||||
## Usage
|
||||
|
||||
### Build the site
|
||||
```bash
|
||||
make build
|
||||
```
|
||||
or
|
||||
```bash
|
||||
python3 build.py
|
||||
```
|
||||
|
||||
### Serve locally
|
||||
```bash
|
||||
make serve
|
||||
```
|
||||
Serves the site at http://localhost:8000
|
||||
|
||||
### Deploy to remote server
|
||||
```bash
|
||||
make deploy
|
||||
```
|
||||
Before deploying, copy `deploy.config.example` to `deploy.config` and fill in your server details.
|
||||
|
||||
Edit `config/services.json` to customize content. Output is generated in `dist/`.
|
||||
|
||||
## Structure
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue