Skip to content

Commit

Permalink
Update readme for new requirements and steps
Browse files Browse the repository at this point in the history
Signed-off-by: Shauna Gordon <[email protected]>
  • Loading branch information
ShaunaGordon committed Dec 4, 2024
1 parent 048c695 commit d7dc072
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ If you are working on the documentation or interested in seeing a specific branc

To build the O3DE website locally, you need the items below.
- `o3de.org` repository
- **Hugo (extended version 0.93 or later)**, a static site generator that builds the website.
- **Hugo (extended version 0.139 or later)**, a static site generator that builds the website.
- **Go (version 1.23.0 or later)**, the runtime for Hugo and its associated features. This may install with Hugo, depending on your install method. Run `go version` after installing Hugo to verify.
- **dart-sass**, the current Sass processor, which doesn't ship with Hugo.
- **npm** (or another package manager) to install the **bootstrap** package, which Hugo needs for styling.

### Download the repository
Expand All @@ -25,14 +27,15 @@ You can download this repository or clone it onto your local machine. Cloning th
### Setup Hugo, npm, and dependencies
1. To install **Hugo (extended version)**, follow the instructions for your machine in the [Hugo documentation](https://gohugo.io/getting-started/installing).

*Note: You must install the **extended version** of Hugo, version 0.93 or later. If downloading a prebuilt binary, make sure the filename starts with `hugo_extended`.*
*Note: You must install the **extended version** of Hugo, version 0.139 or later. If downloading a prebuilt binary, make sure the filename starts with `hugo_extended`.*

2. To install **npm**, follow the instructions in the [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) documentation. Installing npm also installs **Node.js**.

3. To install dependencies, run the following command from the `o3de.org` repository:

```shell
cd <path-to-repo>/o3de.org
hugo mod get
npm install
```

Expand Down

0 comments on commit d7dc072

Please sign in to comment.