Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NeilJustice committed Jan 8, 2025
1 parent 39f93ee commit d7a8891
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
Expand Up @@ -24,8 +24,8 @@ Three use cases for FileArb:
* [FileArb code structure as it appears in Visual Studio 2022 on Windows](#filearb-code-structure-as-it-appears-in-visual-studio-2022-on-windows)
* [Linux Jenkins jobs which build and statically analyze FileArb](#linux-jenkins-jobs-which-build-and-statically-analyze-filearb)
* [Windows Jenkins jobs which build and statically analyze FileArb](#windows-jenkins-jobs-which-build-and-statically-analyze-filearb)
* [4 commands to build binary filearb on Linux with Clang](#4-commands-to-build-binary-filearb-on-linux-with-clang)
* [4 commands to build executable FileArb.exe on Windows with Visual Studio 2022](#4-commands-to-build-executable-filearbexe-on-windows-with-visual-studio-2022)
* [Steps to build binary filearb on Linux with Clang](#steps-to-build-binary-filearb-on-linux-with-clang)
* [Steps to build executable FileArb.exe on Windows with Visual Studio 2022](#steps-to-build-executable-filearbexe-on-windows-with-visual-studio-2022)
* [Thanks to](#thanks-to)

## FileArb command line usage
Expand Down Expand Up @@ -167,26 +167,26 @@ Console output for `filearb create-text-files --target=target_dir --directories=

![Windows FileArb Jenkins jobs](Screenshots/Windows/WindowsFileArbJenkinsJobs.png)

## 4 commands to build binary filearb on Linux with Clang
## Steps to build binary filearb on Linux with Clang

```bash
git clone https://github.com/NeilJustice/FileArb
cd FileArb && mkdir Release && cd Release
CXX=clang++ cmake .. -GNinja -DCMAKE_BUILD_TYPE=Release
CXX=clang++ cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo
sudo cmake --build . --target install
```

Resulting binary `/usr/local/bin/filearb`:

![Resulting binary filearb](Screenshots/Linux/filearbBinaryOnLinux.png)

## 4 commands to build executable FileArb.exe on Windows with Visual Studio 2022
## Steps to build executable FileArb.exe on Windows with Visual Studio 2022

```powershell
git clone https://github.com/NeilJustice/FileArb
cd FileArb
cmake . -G"Visual Studio 17 2022" -A x64 -DCMAKE_INSTALL_PREFIX=C:\bin
cmake --build . --config Release --target install
cmake . -G"Visual Studio 17 2022" -A x64 -DCMAKE_INSTALL_PREFIX="C:\bin"
cmake --build . --config RelWithDebInfo --target install
```

Resulting executable `C:\bin\FileArb.exe`:
Expand All @@ -196,3 +196,4 @@ Resulting executable `C:\bin\FileArb.exe`:
## Thanks to

<a href="https://brandmark.io">brandmark.io</a> for FileArb's logo

0 comments on commit d7a8891

Please sign in to comment.