Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
mdcfe committed Jan 21, 2021
1 parent ad0eae3 commit 8ae681e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# EssentialsX Website

The EssentialsX website hosted at https://essentialsx.net.

This website is a static site generated using [Saber](https://saber.land/). The site uses the [Bulma](https://bulma.io) and [Buefy](https://buefy.org) frameworks.

## Building

### Set up your environment

1. Ensure you have Git, Node.js and Yarn installed and on your path
2. Clone the repository
3. Run `git submodule update --init --recursive`
4. Run `yarn install`

### Commands

- To start a development server with live reload: `yarn saber`
- To build a site for deployment: `yarn saber build`
- To update wiki content: `git submodule update --recursive --remote`

0 comments on commit 8ae681e

Please sign in to comment.