Skip to content

Commit dfc46a2

Browse files
committed
Convert README from Restructured Text to Markdown
And update badge from Azure Pipelines to GitHub Actions.
1 parent 8433946 commit dfc46a2

File tree

2 files changed

+24
-26
lines changed

2 files changed

+24
-26
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CastXML Superbuild
2+
3+
[![CI](https://github.com/CastXML/CastXMLSuperbuild/actions/workflows/ci.yml/badge.svg)](https://github.com/CastXML/CastXMLSuperbuild/actions/workflows/ci.yml)
4+
5+
This builds [CastXML](https://github.com/CastXML/CastXML) and its
6+
dependencies (LLVM/Clang) with CMake\'s
7+
[ExternalProject](http://www.cmake.org/cmake/help/git-master/module/ExternalProject.html)
8+
module. It is a cross-platform way to build CastXML.
9+
10+
This can be built like any other [CMake](http://cmake.org) project. For
11+
example:
12+
13+
git clone https://github.com/CastXML/CastXMLSuperbuild.git
14+
mkdir CastXMLSuperbuild-build
15+
cd CastXMLSuperbuild-build
16+
cmake ../CastXMLSuperbuild
17+
make
18+
19+
The resulting [castxml]{.title-ref} executable will be located at
20+
[CastXMLSuperbuild-build/castxml/bin/castxml]{.title-ref}.
21+
22+
The resulting binary builds for Linux, Mac OSX, and Windows [are
23+
available
24+
here](https://data.kitware.com/#collection/57b5c9e58d777f126827f5a1/folder/57b5de948d777f10f2696370).

README.rst

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)