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. All you need is ten minutes and an Internet connection.

# 1. Prerequisites
Linux:
```bash
apt install -y gcc make libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libgl1-mesa-dev libxxf86vm-dev libgtk-3-dev xdg-utils libglu1-mesa xclip coreutils
```
macOS:
```bash
xcode-select --install
```
Windows: A C compiler, ideally [TDM-GCC](https://jmeubank.github.io/tdm-gcc/)

# 2. Install the Go Programming Language
If you don't have Go installed, download the corresponding installer for Go from <a href="https://golang.org/dl">here</a>, or from your package manager. The latest version of Go is required.

# 3. Get the Source Files
Download the source files as a zip from the homepage or `git clone` this repository.

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

# 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!
Update README.md 2021-08-07 23:14:35 +00:00			`# Running From Source`
Incorporate go.mod and go.sum 2021-08-11 16:35:34 +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. 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`
			`Linux:`
Change platform specific instructions to generic 2021-05-30 15:25:13 +00:00			```bash
Incorporate go.mod and go.sum 2021-08-11 16:35:34 +00:00			`apt install -y gcc make libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libgl1-mesa-dev libxxf86vm-dev libgtk-3-dev xdg-utils libglu1-mesa xclip coreutils`
Update README.md 2021-05-29 19:38:13 +00:00			```
Update README.md 2021-08-07 22:05:44 +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`
Formatting, details 2021-06-01 16:02:56 +00:00			```
Update README.md 2021-08-07 23:14:35 +00:00			`Windows: A C compiler, ideally [TDM-GCC](https://jmeubank.github.io/tdm-gcc/)`
Formatting, details 2021-06-01 16:02:56 +00:00
			`# 2. Install the Go Programming Language`
Update README.md 2021-08-29 22:56:19 +00:00			`If you don't have Go installed, download the corresponding installer for Go from <a href="https://golang.org/dl">here</a>, or from your package manager. The latest version of Go is required.`
Formatting, details 2021-06-01 16:02:56 +00:00
			`# 3. Get the Source Files`
Incorporate go.mod and go.sum 2021-08-11 16:35:34 +00:00			Download the source files as a zip from the homepage or `git clone` this repository.
Formatting, details 2021-06-01 16:02:56 +00:00
Remove the need to edit code for compilation when not on Windows 2021-09-25 18:07:56 +00:00			`# 4. Build From Source`
			`- Windows: <code>go build -ldflags "-s -w -H=windowsgui -extldflags=-static"</code>`
			`- macOS: <code>go build -ldflags "-s -w"</code>`
			`- Linux: <code>go build -ldflags "-s -w"</code>`
Change platform specific instructions to generic 2021-05-30 15:25:13 +00:00
Remove the need to edit code for compilation when not on Windows 2021-09-25 18:07:56 +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!