From 84cfd69cb5e3fe712f73ea51f3edf3b347918447 Mon Sep 17 00:00:00 2001 From: San Jacobs Date: Wed, 17 May 2023 02:57:29 +0200 Subject: Updated readme for odin branch --- README.md | 30 ++++-------------------------- 1 file changed, 4 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 7712565..98b298c 100644 --- a/README.md +++ b/README.md @@ -7,38 +7,16 @@ You put in the time you worked, and it produces a nice receipt that you can copy ## Building from source -### 🐧 Linux and MacOS 🍎 - -You'll need `gcc` and `make`. - -``` -git clone https://github.com/SanJacobs/satscalc -cd satscalc -make -``` - -And if you want to install it, do: - -``` -sudo make install -``` - -### 🪟 Windows / cross-compilation ⚡ - -You'll need `zig` (Tested with 0.9.1) and `make`. - -Using zig because MinGW/GCC can't supply .pdb files needed for debugging with RemedyBG, and clang on Windows is a pain. MSVC is even more of a pain. +You'll need `odin` ``` -git clone https://github.com/SanJacobs/satscalc -cd satscalc -make windows +odin build src/ -out:satscalc ``` -Or `make windows32` if you need a 32-bit binary. +Put `.exe` after `-out:satscalc` if you're on Windows. ## State of development -It's basically in a usable state now. +This is the odin-branch. It is not finished yet, but will hopefully have a nice comfy GUI once it is finished. Currently, the only ruleset implemented is the one for advertisement and short-term work. Others may be added in the future. -- cgit v1.2.1