Skip to content

Commit

Permalink
[Ant4C] updated README.md.
Browse files Browse the repository at this point in the history
Removed not available at v2019.10.21 functions from string name space.
Added note about project LICENSE.
  • Loading branch information
TheVice committed Feb 4, 2020
1 parent 1cc4044 commit 0d1e101
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Ant4C
Tool that interprets scenarios. Similar to Apache Ant and NAnt. Written in C.

#Overview
## Overview
Ant for C is C-based script tool. Source of script should be written in XML-based code.
For understanding why tools with such vision was written read [Apache Ant Introduction](http://jakarta.apache.org/ant/manual/) or/and [NAnt help](http://nant.sourceforge.net/).

Expand All @@ -11,15 +11,15 @@ For first initial release echo and exec tasks support. Targets are not support.

Developing was started in August of 2019 and first present to the public in October of 2019.

#Downloads
## Downloads
Binaries for Windows, Ubuntu 16.04, OpenBSD 6.5 and FreeBSD 12.0 are available on [release page](https://github.com/TheVice/Ant4C/releases).
Also library available to use ant4c with other C/C++ projects.
For Windows binaries present after compiled with MinGW and Visual Studio 2019.

#Differences from NAnt
## Differences from NAnt
Some name space have addition functions (like is64bit-operating-system from environment) and addition version (like substring with two arguments from string addition to version with three arguments) comparing to NAnt implementation. Some functions are missed.

#Building
## Building
Build can be done by one of C compilers - MSVC, MinGW, GCC or CLang, after configuring with [CMake](http://www.cmake.org/download/).
For release configuration, without version information, Ant4C script can be used.
* ant4c_app -buildfile:build.build -D:cmake=cmake
Expand All @@ -32,7 +32,7 @@ For release configuration, without version information, Ant4C script can be used

Of course full path to cmake (for example -D:cmake=/usr/local/bin/cmake or -D:cmake="C:\Program Files\cmake\bin\cmake.exe") and build file should be provided.

#List of functions
## List of functions
```
bool::parse
bool::to-string
Expand Down Expand Up @@ -182,8 +182,6 @@ string::equal
string::get-length
string::index-of
string::last-index-of
string::pad-left
string::pad-right
string::quote
string::replace
string::starts-with
Expand All @@ -208,3 +206,6 @@ version::get-major
version::get-minor
version::get-revision
```

## License
This project available under terms of [MIT License](LICENSE).

0 comments on commit 0d1e101

Please sign in to comment.