Picocrypt/src/README.md

59 lines
2.6 KiB
Markdown
Raw Normal View History

2021-08-08 11:14:35 +12:00
# 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 simple instructions. I'll assume that you are familiar with the Go language and how to deal with modules.
2021-05-30 07:38:13 +12:00
2021-06-02 04:02:56 +12:00
# 1. Prerequisites
Linux:
```bash
2021-08-08 10:57:09 +12:00
sudo apt-get 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
2021-05-30 07:38:13 +12:00
```
2021-08-08 10:05:44 +12:00
macOS:
2021-06-02 04:02:56 +12:00
```bash
2021-08-08 10:05:44 +12:00
xcode-select --install
2021-06-02 04:02:56 +12:00
```
2021-08-08 11:14:35 +12:00
Windows: A C compiler, ideally [TDM-GCC](https://jmeubank.github.io/tdm-gcc/)
2021-06-02 04:02:56 +12:00
# 2. Install the Go Programming Language
2021-08-08 11:34:15 +12:00
Download the corresponding installer for Go from <a href="https://golang.org/dl">here</a>, or from your package manager. Go 1.16 or later is recommended.
2021-06-02 04:02:56 +12:00
# 3. Get the Source Files
Download the source file `Picocrypt.go` from above or `git clone` this repository.
2021-08-08 10:05:44 +12:00
# 4. Get Resources
2021-08-08 11:14:35 +12:00
Place all the files in the `resources` directory above into the same directory as `Picocrypt.go`.
2021-08-08 10:05:44 +12:00
2021-08-08 11:14:35 +12:00
# 5. Create a go.mod
2021-08-08 11:07:17 +12:00
Go to where `Picocrypt.go` is located and create a go.mod:
2021-05-30 07:38:13 +12:00
```bash
2021-06-02 14:27:55 +12:00
go mod init Picocrypt
2021-05-30 07:38:13 +12:00
```
2021-06-02 04:02:56 +12:00
2021-08-08 12:59:39 +12:00
# 6. Install Dependencies
2021-08-08 11:07:36 +12:00
Install each of the following modules via `go get -u -v`:
2021-05-30 07:38:13 +12:00
```bash
2021-08-08 10:57:09 +12:00
golang.org/x/crypto
2021-08-10 03:39:39 +12:00
github.com/AllenDang/giu
2021-08-08 10:57:09 +12:00
github.com/HACKERALERT/serpent@v0.0.0-20210716182301-293b29869c66
github.com/HACKERALERT/infectious@v0.0.0-20210730231340-8af02cb9ed0a
github.com/HACKERALERT/clipboard@v0.1.5-0.20210716140604-61d96bf4fc94
github.com/HACKERALERT/dialog@v0.0.0-20210716143851-223edea1d840
github.com/HACKERALERT/browser@v0.0.0-20210730230128-85901a8dd82f
github.com/HACKERALERT/zxcvbn-go@v0.0.0-20210730224720-b29e9dba62c2
2021-05-30 07:38:13 +12:00
```
2021-06-02 09:55:04 +12:00
2021-08-08 12:58:34 +12:00
# 7. If You're Not on Windows
Windows requires a couple of extra lines to hide the command prompt window that shows when shredding a file. If you're not on Windows, however, you'll need to delete all occurrences of this line: `cmd.SysProcAttr = &syscall.SysProcAttr{HideWindow:true}`. You'll also need to remove the import of `syscall`.
# 8. Build From Source
2021-08-08 11:14:35 +12:00
Tidy the modules:
2021-06-02 14:27:55 +12:00
```bash
go mod tidy
```
2021-08-08 12:58:34 +12:00
2021-08-08 11:14:35 +12:00
Build Picocrypt from source:
- Windows: <code>go build -ldflags "-s -w -H=windowsgui -extldflags=-static" Picocrypt.go</code>
2021-06-02 04:02:56 +12:00
- macOS: <code>go build -ldflags "-s -w" Picocrypt.go</code>
- Linux: <code>go build -ldflags "-s -w" Picocrypt.go</code>
2021-08-08 12:58:34 +12:00
# 9. Done!
2021-08-08 11:14:35 +12: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!