Skip to content

Commit 0d7b331

Browse files
committed
📝 add documentation about building the log4net site
1 parent d240b21 commit 0d7b331

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

BUILDING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,15 @@ Options:
2929
included which (should) build if you set up AppVeyer to track
3030
your fork. AppVeyer is free for open-source projects.
3131
(TODO: should have a link to the official AppVeyer build)
32-
- build via the CircleCI Windows image. There is included configuration for CircleCI.
33-
CicleCI is free (with usage limitations) for open-source projects.
32+
33+
## Updating the site
34+
35+
Log4Net uses Maven to build the site. Source artifacts can be found under `src/site`.
36+
Building the site can be accomplished with `npm run build-site`. You should have maven
37+
installed:
38+
- Windows: get it from Scoop
39+
- OSX: get it from Homebrew
40+
- Linux: use your package manager
41+
42+
The site will be generated in `target/site`, and can be viewed locally. Updates should
43+
be pushed to the `asf-staging` branch of [https://github.com/apache/logging-log4net-site]()

0 commit comments

Comments
 (0)