Update READ.md with relevant parts of Tim's file

This commit is contained in:
Satya L. Johnson 2021-09-07 01:31:20 -04:00 committed by GitHub
parent 3c6abecaa6
commit 920fda5f98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 42 additions and 1 deletions

View File

@ -1,2 +1,43 @@
# satch.xyz
My new website
My new website is mostly a complete copy of [Tim Visée's site](https://timvisee.com). But that is slowly (slowly) changing as I add my own content and remove his.
## Content
The majority of the content is formatted in Markdown, located in the
[`./content`](./content/) directory.
It includes a custom theme as well ([zenn][zenn]) for the visuals, by Tim Visée.
This website is built with [Zola][zola], a static website generator.
See its documentation for more information on how this project is structured.
Any pull requests for changes on the website are welcome.
## Usage
To run a local instance of this website, be sure to install [`zola`][zola] first.
Then run:
```bash
# Clone the repository
git clone https://github.com/satchlj/satch.xyz
cd satch.xyz
# Build and serve a local instance
zola serve --open
# Open: 127.0.0.1:1111
# Edit files in ./content, view live changes your browser
# Build and deploy
zola build
# serve static files in public directory to web
```
## License
This project is released under the GNU AGPL-3.0 license.
Check out the [LICENSE][license] file for more information.
Feel free to use parts of this project, such as the custom [zenn][zenn] theme,
in your own project conform the [LICENSE][license].
[site]: https://satch.xyz/
[zola]: https://getzola.org/
[zenn]: ./themes/zenn/
[license]: ./LICENSE