Skip to content

Commit b5ae2ac

Browse files
committed
📝 add build documentation
🔧 explicitly include appveyer config to make it easier to fire up under another account
1 parent 7643c18 commit b5ae2ac

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

BUILDING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Building log4net
2+
3+
Log4net provides support for a wide array of targets, including
4+
- older .net 2 and 3.5 (including client profiles)
5+
- more modern net40/net45
6+
- netstandard1.3/2.0
7+
8+
As such, it does require a relatively full .net environment on Windowsa to build.
9+
10+
Options:
11+
- build locally. Suggested environment:
12+
- Pre-requisites:
13+
- Visual Studio 2019 Build Tools
14+
- Ensure you have .NET Framework 3.5 SP1 installed
15+
- on Win10+, this can only be installed via Add/Remove Windows Components
16+
- on other platforms, see https://dotnet.microsoft.com/download/dotnet-framework/net35-sp1
17+
- Building against .net 2/3.5, especially Client Profile, is not supported on Mono
18+
- Binaries can be built with a Visual Studio or Rider installation
19+
- Binaries, packages and a release zip can be built via commandline
20+
- Ensure that you have a reasonably modern NodeJS installed (at least version 8+)
21+
- `npm ci`
22+
- `npm run build`
23+
- optionally `npm test` to run all tests
24+
- optionally `npm run release` to generate release artifacts
25+
- build via the vs2019 Windows AppVeyer image. There is an appveyer.yml file
26+
included which (should) build if you set up AppVeyer to track
27+
your fork. AppVeyer is free for open-source projects.
28+
(TODO: should have a link to the official AppVeyer build)
29+
- build via the CircleCI Windows image. There is included configuration for CircleCI.
30+
CicleCI is free (with usage limitations) for open-source projects.

appveyer.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 1.0.{build}
2+
image: Visual Studio 2019
3+
build_script:
4+
- cmd: >-
5+
npm ci
6+
npm test
7+
npm run release
8+
9+
artifacts:
10+
- path: build/artifacts/*

0 commit comments

Comments
 (0)