Skip to content

Commit

Permalink
📝 add documentation about building the log4net site
Browse files Browse the repository at this point in the history
  • Loading branch information
fluffynuts committed Sep 5, 2020
1 parent d240b21 commit 0d7b331
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,15 @@ Options:
included which (should) build if you set up AppVeyer to track
your fork. AppVeyer is free for open-source projects.
(TODO: should have a link to the official AppVeyer build)
- build via the CircleCI Windows image. There is included configuration for CircleCI.
CicleCI is free (with usage limitations) for open-source projects.

## Updating the site

Log4Net uses Maven to build the site. Source artifacts can be found under `src/site`.
Building the site can be accomplished with `npm run build-site`. You should have maven
installed:
- Windows: get it from Scoop
- OSX: get it from Homebrew
- Linux: use your package manager

The site will be generated in `target/site`, and can be viewed locally. Updates should
be pushed to the `asf-staging` branch of [https://github.com/apache/logging-log4net-site]()

0 comments on commit 0d7b331

Please sign in to comment.