diff --git a/README.md b/README.md index dcef569..81b23d8 100644 --- a/README.md +++ b/README.md @@ -26,16 +26,35 @@ This project automates the process of navigating to the IPLeiria GISEM platform ## Usage -To run the project, execute the following command: +To run the project without building it, execute the following command: ```sh -go run main.go +go run . ``` -As another option you can build the project by running: +## Building the Project + +### For your current OS ```sh -go build . +go build -o gisem_presencas +``` + +### Cross-platform builds + +#### For Windows +```sh +GOOS=windows GOARCH=amd64 go build -o gisem_presencas.exe +``` + +#### For macOS +```sh +GOOS=darwin GOARCH=amd64 go build -o gisem_presencas_mac +``` + +#### For Linux +```sh +GOOS=linux GOARCH=amd64 go build -o gisem_presencas_linux ``` And run it like: @@ -44,6 +63,11 @@ And run it like: ./gisem_presencas -w value ``` +On Windows: +```sh +gisem_presencas.exe -w value +``` + ## Flags - `-w` or `-wait`: Time to wait in between refreshes (default is 30 seconds). @@ -52,8 +76,6 @@ And run it like: - `main.go`: The main entry point of the application. - `utils.go`: Contains utility functions such as flag parsing and the welcome message. -- `.env`: Environment variables file. -- `example.env`: Example environment variables file. - `go.mod`: Go module dependencies. - `go.sum`: Go module dependency checksums. - `README.md`: Project documentation.