Documentation (0.5)
Build From Source
- set BYLDAN environment variable to the location of byldan distribution
- Open IDE
- Build Project
- ./package.sh
If you want to build on Windows, you will need to create a batch file, similar to the package.sh
Installing
- Go to the releases section and download the latest binary version
- Unzip into a directory
- set BYLDAN environment variable to the location of byldan distribution
- Place the directory $BYLDAN/bin within your path
Setting up and Building a Simple Project
To setup a single-module project:
- Create the project directory
- Go to the root of the project directory, at create a new file called pom.xml. It should looks something like:
<project>
<groupId>Byldan</groupId>
<artifactId>Byldan.Test</artifactId>
<version>1.1.0.3</version>
<packaging>dotnet:library</packaging>
</project>
In the Packaging tag, you can use the following value: dotnet:library, dotnet:winexe, dotnet:exe, dotnet:netmodule, project
- Add your classes
- Type bd install
- Look under the target directory for the assembly file: it will be named <artifactId>.<extension_type>
To clean the directories, type "bd clean".
Using Dependencies
To use dependencies:
- Create a new project and setup your pom.xml similar to the following:
<project>
<groupId>Byldan</groupId>
<artifactId>Byldan.Test.Dependency</artifactId>
<version>1.1.0.3</version>
<packaging>dotnet:exe</packaging>
<dependencies>
<dependency>
<groupId>Byldan</groupId>
<artifactId>Byldan.Test</artifactId>
<version>1.1.0.3</version>
<type>dotnet:library</type>
</dependency>
</dependencies>
</project>
If the dependency has already been installed into the GAC, then the 'packaging' field should specify 'gac' instead of 'dotnet:library'.
- Create your class files that use classes from the Byldan.Test assembly.
- Type bd install
- Look under the target directory for the assembly file: it will be named <artifactId>.<extension_type>
Multi-module Builds
To setup multi-module builds, go to the parent directory of your projects, and create another pom.xml file:
<project>
<groupId>Byldan</groupId>
<artifactId>Byldan.Test.Multimodule</artifactId>
<version>1.1.0.3</version>
<packaging>project</packaging>
<modules>
<module>simple-build</module>
<module>simple-dependency</module>
</modules>
</project>
The module names should match the directories of your project. Ordering ode modules does not matter. Byldan will determine the build order for you.
- Type bd install
- Look under the target directory of each project for the assembly file: it will be named <artifactId>.<extension_type>
Using Custom Build Tasks
Not supported in 0.5. Targeted feature for 0.6
Using NUnit
You will need nunit-console located within your path. Within your project directory, create a directory called 'Tests'. Place your NUnit tests in this directory. From the directory containing the pom.xml file, type:
bd install
Byldan will automatically compile and run the unit tests.
Signing Assemblies
Just place your snk file within the ~/.m2/byldan directory (this directory also contains your build artifacts). Byldan will automatically pick it up and sign your project assemblies.