Skip to content

Commit 04bdcfb

Browse files
committed
feat: PRSDM-10268 bring Presidium Open Source up to date
1 parent b1cc45e commit 04bdcfb

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,26 @@ Read Presidium's [documentation](http://presidium.spandigital.net/overview/) for
1313
For detailed instructions on getting started, please see [Getting Started](http://presidium.spandigital.net/getting-started/).
1414

1515
# Features and Issues
16-
All upcoming features and issues are tracked [here](https://github.com/SPANDigital/presidium/issues).
16+
All upcoming features and issues are tracked [here](https://github.com/SPANDigital/presidium/issues).
17+
18+
# Development
19+
20+
Presidium embeds a specific verison of [Hugo](https://github.com/gohugoio/hugo) to ensure that the user is building their docs with a Hugo version that is compatible with our Presidium Themes.
21+
22+
Since we require the embedded Hugo version to be built into a binary, some of the cli commands only work after running the `make build` cmd.
23+
24+
## Getting started
25+
26+
Run the build command:
27+
```
28+
make build
29+
```
30+
31+
Move the binary into a valid documentation site directory, then run the hugo build cmd:
32+
```
33+
./presidium hugo
34+
```
35+
Or if you want to serve the site after the hugo build, then run:
36+
```
37+
./presidium hugo server
38+
```

0 commit comments

Comments
 (0)