Skip to content

Commit 926d1b0

Browse files
committed
doc(readme) + CI Badge and readme header reworked a little
1 parent 2c5cf74 commit 926d1b0

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22

33
![delphi-msbuild logo](https://continuous-delphi.github.io/assets/logos/delphi-msbuild-480x270.png)
44

5+
[![CI](https://github.com/continuous-delphi/delphi-msbuild/actions/workflows/ci.yml/badge.svg)](https://github.com/continuous-delphi/delphi-msbuild/actions/workflows/ci.yml)
56
![Status](https://img.shields.io/badge/status-incubator-orange)
67
![License](https://img.shields.io/github/license/continuous-delphi/delphi-inspect.svg)
78
![Delphi](https://img.shields.io/badge/delphi-red)
89
![PowerShell](https://img.shields.io/badge/powershell-7.4%2B-blue)
910
![Continuous Delphi](https://img.shields.io/badge/org-continuous--delphi-red)
1011

12+
Quick-start, or enhance your Delphi build automation with a standalone,
13+
MIT-licensed, CI-ready build tool from
14+
[Continuous-Delphi](https://github.com/continuous-delphi) -
15+
designed for automating builds using MSBuild.
16+
See [delphi-dccbuild](https://github.com/continuous-delphi/delphi-dccbuild)
17+
for a similar tool that utilizes the DCC command line compilers.
1118

1219
# Overview
1320

@@ -16,23 +23,29 @@ MSBuild. It sources the Delphi build environment from `rsvars.bat`
1623
(located under the Delphi installation root) and then invokes MSBuild
1724
with the requested project file, platform, and configuration.
1825

19-
# Usage
26+
It is designed to be used standalone by providing the `ProjectFile` path
27+
and the Delphi `RootDir` (and optionally the Platform and Config settings.)
2028

2129
```powershell
22-
pwsh delphi-msbuild.ps1 -ProjectFile <path> [options]
30+
delphi-msbuild.ps1 `
31+
-ProjectFile .\src\MyApp.dpr `
32+
-RootDir 'C:\Program Files (x86)\Embarcadero\Studio\23.0'
2333
```
2434

25-
------------------------------------------------------------------------
26-
27-
It is designed to be run stand-alone (using an explicit `-RootDir`
28-
parameter) or to pipe the output of `delphi-inspect.ps1` which will
29-
supply the installation root, such as:
35+
You can also pipe the output from `delphi-inspect.ps1` to automatically
36+
detect the `RootDir`:
3037

3138
```powershell
3239
delphi-inspect.ps1 -DetectLatest -Platform Win32 -BuildSystem MSBuild |
3340
delphi-msbuild.ps1 -ProjectFile .\src\MyApp.dproj
3441
```
3542

43+
# Usage
44+
45+
```powershell
46+
pwsh delphi-msbuild.ps1 -ProjectFile <path> [options]
47+
```
48+
3649
# Parameters
3750

3851
## -ProjectFile

0 commit comments

Comments
 (0)