aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2019-11-21 00:08:12 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2019-11-21 01:00:50 -0500
commit6a0aa493a001df88c31dc41d3bd03b9433347235 (patch)
tree54ebb52effff630eb528582349880e7e8a8d9896 /README.md
parente3d36cb0249dcea99702db3694c0b1c2691d1ee2 (diff)
downloadreloc-6a0aa493a001df88c31dc41d3bd03b9433347235.tar.gz
GitHub Actions
* Add MSVC support * Update README.md to reflect changes * Implement ci.yml * Add missing argument to usage statement
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 551118b..fea1715 100644
--- a/README.md
+++ b/README.md
@@ -2,21 +2,38 @@
Replace strings in binary executables and data files.
+![](https://github.com/jhunkeler/reloc/workflows/ci/badge.svg)
+
## System Requirements
* `gcc`
+* _or_ `clang`
+* _or_ Microsoft Visual Studio (`cl.exe`)p
* `>=cmake-2.18.11`
## Installing
+### Linux / MacOS
+
```bash
$ git clone https://github.com/jhunkeler/reloc
$ mkdir build
$ cd build
-$ cmake -DCMAKE_INSTALL_PREFIX=/some/place ..
+$ cmake -DCMAKE_INSTALL_PREFIX=/some/place -DCMAKE_BUILD_TYPE=Release ..
$ make install
```
+### Windows
+
+```cmd
+> git clone https://github.com/jhunkeler/reloc
+> cd reloc
+> mkdir build
+> cd build
+> cmake -DCMAKE_INSTALL_PREFIX=c:\some\place -DCMAKE_BUILD_TYPE=Release ..
+> cmake --build . --target INSTALL
+```
+
## Usage
```
$ reloc <str1> <str2> <input_file> <output_file>