Picocrypt/src/README.md

# Running From Source
If you would like to run Picocrypt from source, or an executable isn't available for your platform, you've come to the right place. Running from source is very simple, and I've made it even easier with these straightforward instructions. Unlike VeraCrypt, which requires complex build procedures, SDKs, and assemblers, Picocrypt can easily be compiled from source with only a Go and C compiler. All you need is ten minutes and an Internet connection.

# 1. Prerequisites
**Linux:**
```bash
apt install -y gcc xorg-dev libgtk-3-dev libgl1-mesa-dev libglu1-mesa
```
**macOS:**
```bash
xcode-select --install
brew install glfw glew
```
**Windows:** A C compiler, ideally TDM-GCC or MinGW-w64

# 2. Install Go
If you don't have Go installed, download it from <a href="https://go.dev/dl/">here</a> or install it from your package manager (`apt install golang-go`). The latest version of Go is recommended, although you may fall back to Go 1.19 should any issues arise in the future.

# 3. Get the Source Files
Download the source files as a zip from the homepage or `git clone` this repository. Next, navigate to the `src/` directory, where you will find the source file (`Picocrypt.go`). You will need this file, along with `go.mod` and `go.sum`, to compile Picocrypt.

# 4. Build From Source
Finally, build Picocrypt from source:
- Windows: <code>go build -ldflags="-s -w -H=windowsgui -extldflags=-static" Picocrypt.go</code>
- macOS: <code>go build -ldflags="-s -w" Picocrypt.go</code>
- Linux: <code>go build -ldflags="-s -w" Picocrypt.go</code>

Note: Make sure to set `CGO_ENABLED=1` if it isn't already.

# 5. Done!
You should now see a compiled executable (`Picocrypt.exe`/`Picocrypt`) in your directory. You can run it by double-clicking or executing it in your terminal. That wasn't too hard, right? Enjoy!

Note: On Linux, if hardware OpenGL isn't available, you can set `LIBGL_ALWAYS_SOFTWARE=1` to force Mesa to use software rendering. This way, Picocrypt will be able to run regardless of driver support and can even run without a GPU at all. You may also need to set `NO_AT_BRIDGE=1` to disable the accessibility bus which is known to cause potential issues.
Update README.md 2021-08-07 23:14:35 +00:00			`# Running From Source`
Update README.md 2021-11-20 03:14:49 +00:00			`If you would like to run Picocrypt from source, or an executable isn't available for your platform, you've come to the right place. Running from source is very simple, and I've made it even easier with these straightforward instructions. Unlike VeraCrypt, which requires complex build procedures, SDKs, and assemblers, Picocrypt can easily be compiled from source with only a Go and C compiler. All you need is ten minutes and an Internet connection.`
Update README.md 2021-05-29 19:38:13 +00:00
Formatting, details 2021-06-01 16:02:56 +00:00			`# 1. Prerequisites`
Add homebrew requirements 2021-12-31 16:53:25 +00:00			`Linux:`
Change platform specific instructions to generic 2021-05-30 15:25:13 +00:00			```bash
Remove xclip (not needed anymore) 2022-11-18 16:53:25 +00:00			`apt install -y gcc xorg-dev libgtk-3-dev libgl1-mesa-dev libglu1-mesa`
Update README.md 2021-05-29 19:38:13 +00:00			```
Add homebrew requirements 2021-12-31 16:53:25 +00:00			`macOS:`
Formatting, details 2021-06-01 16:02:56 +00:00			```bash
Update README.md 2021-08-07 22:05:44 +00:00			`xcode-select --install`
Add homebrew requirements 2021-12-31 16:53:25 +00:00			`brew install glfw glew`
Formatting, details 2021-06-01 16:02:56 +00:00			```
Update links 2022-08-28 03:34:37 +00:00			`Windows: A C compiler, ideally TDM-GCC or MinGW-w64`
Formatting, details 2021-06-01 16:02:56 +00:00
Simplify 2022-08-28 02:44:43 +00:00			`# 2. Install Go`
set CGO_ENABLED=1 2022-12-25 18:32:27 +00:00			If you don't have Go installed, download it from <a href="https://go.dev/dl/">here</a> or install it from your package manager (`apt install golang-go`). The latest version of Go is recommended, although you may fall back to Go 1.19 should any issues arise in the future.
Formatting, details 2021-06-01 16:02:56 +00:00
			`# 3. Get the Source Files`
Improvements 2022-09-05 21:19:04 +00:00			Download the source files as a zip from the homepage or `git clone` this repository. Next, navigate to the `src/` directory, where you will find the source file (`Picocrypt.go`). You will need this file, along with `go.mod` and `go.sum`, to compile Picocrypt.
Formatting, details 2021-06-01 16:02:56 +00:00
Update README.md 2021-11-20 03:14:49 +00:00			`# 4. Build From Source`
Revert "Update README.md" This reverts commit 3814c53b9388fde6005aff8ee543411118980788. 2021-09-29 00:34:50 +00:00			`Finally, build Picocrypt from source:`
Add choco's mingw 2022-03-19 17:09:03 +00:00			`- Windows: <code>go build -ldflags="-s -w -H=windowsgui -extldflags=-static" Picocrypt.go</code>`
			`- macOS: <code>go build -ldflags="-s -w" Picocrypt.go</code>`
			`- Linux: <code>go build -ldflags="-s -w" Picocrypt.go</code>`
Change platform specific instructions to generic 2021-05-30 15:25:13 +00:00
set CGO_ENABLED=1 2022-12-25 18:32:27 +00:00			Note: Make sure to set `CGO_ENABLED=1` if it isn't already.

Update README.md 2021-11-20 03:14:49 +00:00			`# 5. Done!`
Update README.md 2021-08-07 23:14:35 +00:00			You should now see a compiled executable (`Picocrypt.exe`/`Picocrypt`) in your directory. You can run it by double-clicking or executing it in your terminal. That wasn't too hard, right? Enjoy!
Improvements 2022-09-05 21:19:04 +00:00
			Note: On Linux, if hardware OpenGL isn't available, you can set `LIBGL_ALWAYS_SOFTWARE=1` to force Mesa to use software rendering. This way, Picocrypt will be able to run regardless of driver support and can even run without a GPU at all. You may also need to set `NO_AT_BRIDGE=1` to disable the accessibility bus which is known to cause potential issues.