Skip to content

Commit

Permalink
fix(docs): readme (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
mymindishazel committed Apr 11, 2024
1 parent 8103d81 commit d7a550b
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
# funkin.me source code

This is the source code repository for the FUNKIN CREW WEBSITE, [`funkin.me`](https://funkin.me)
This is the source code repository for the FUNKIN CREW WEBSITE,
[`funkin.me`](https://funkin.me)

It is a static site generated website, using [Zola](https://www.getzola.org/) for generation, and [Pico CSS](https://picocss.com/) for styling.
It is a static site generated website, using [Zola](https://www.getzola.org/)
for generation, and [Pico CSS](https://picocss.com/) for styling.

# Setup

- Installation instrucitons for [zola are here](https://www.getzola.org/documentation/getting-started/installation/). It is just a binary file you either add to your path, or install via package manager!
- We get Pico CSS from NPM, so you need to [install node](https://nodejs.org) if you don't already have it.
- Then you can just `npm install` to get Pico CSS
- Installation instructions for
[zola are here](https://www.getzola.org/documentation/getting-started/installation/).
It is just a binary file you either add to your path, or install via package
manager!
- We get Pico CSS from NPM, so you need to [install node](https://nodejs.org) if
you don't already have it.
- Then you can just `npm ci` to get Pico CSS

# Running the site

From the [Zola CLI usage docs](https://www.getzola.org/documentation/getting-started/cli-usage/)
> [Zola only has 4 commands: `init`, `build`, `serve` and `check`.](https://www.getzola.org/documentation/getting-started/cli-usage/)
So you just need to run `zola serve` to compile and run the site on a local web server.
From the
[Zola CLI usage docs](https://www.getzola.org/documentation/getting-started/cli-usage/)

> [Zola only has 4 commands: `init`, `build`, `serve` and `check`.](https://www.getzola.org/documentation/getting-started/cli-usage/)
So you just need to run `zola serve` to compile and run the site on a local web
server.

0 comments on commit d7a550b

Please sign in to comment.