Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs #37

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Add docs #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 5 additions & 75 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,80 +13,10 @@ Delta-Charlie-6-Bravo-Charlie-Alpha-Echo

The included word lists are derived from the EFF's word lists found [here](https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases) ([archive](https://web.archive.org/web/20210505043502/https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases)).

### Building on Windows
1. MSYS2 is needed to build on Windows. [Get it from the MSYS2 website.](https://www.msys2.org/)
2. Go to your folder for MSYS2 and run `mingw64.exe`. The following commands will be executed in the console that appears.
3. Install git.
```
pacman -S git
```
4. Clone this repository.
```
git clone https://github.com/zevlee/passphraser.git
```
5. Enter the `windows` directory.
```
cd passphraser/windows
```
6. Run `bootstrap.sh` to install any missing dependencies.
```
./bootstrap.sh
```
7. Run `build.sh`.
```
./build.sh
```
Create a portable executable by adding the portable option
```
./build.sh portable
```
## [Documentation](/docs/README.md)

### Building on macOS
1. Homebrew is needed to install PyGObject. [Get it from the Homebrew website.](https://brew.sh)
2. Clone this repository.
```
git clone https://github.com/zevlee/passphraser.git
```
3. Enter the `macos` directory.
```
cd passphraser/macos
```
4. Run `bootstrap.sh` to install any missing dependencies.
```
./bootstrap.sh
```
5. Run `build.sh`.
```
./build.sh
```
Enable code signing by adding the Common Name of the certificate as the first argument. Without this, adhoc signing will be used.
```
./build.sh "Developer ID Application: Name Here (TEAMIDHERE)"
```
Enable notarization by also adding the name of a stored keychain profile.
```
./build.sh "Developer ID Application: Name Here (TEAMIDHERE)" "keychain-profile-here"
```
Notarization can alternatively be enabled by adding Apple ID, Team ID, and an app-specific password as subsequent arguments.
```
./build.sh "Developer ID Application: Name Here (TEAMIDHERE)" "appleid@here.com" "TEAMIDHERE" "pass-word-goes-here"
```
[Building on Windows](/docs/windows.md)

### Building on Linux
1. Ensure PyGObject is installed.
2. Clone this repository.
```
git clone https://github.com/zevlee/passphraser.git
```
3. Enter the `linux` directory.
```
cd passphraser/linux
```
4. Run `bootstrap.sh` to install any missing dependencies.
```
./bootstrap.sh
```
5. Run `build.sh`.
```
./build.sh
```
[Building on macOS](/docs/macos.md)

[Building on Linux](/docs/linux.md)
7 changes: 7 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Documentation

[Building on Windows](/docs/windows.md)

[Building on macOS](/docs/macos.md)

[Building on Linux](/docs/linux.md)
18 changes: 18 additions & 0 deletions docs/linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### Building on Linux
1. Ensure PyGObject is installed.
2. Clone this repository.
```
git clone https://github.com/zevlee/passphraser.git
```
3. Enter the `linux` directory.
```
cd passphraser/linux
```
4. Run `bootstrap.sh` to install any missing dependencies.
```
./bootstrap.sh
```
5. Run `build.sh`.
```
./build.sh
```
30 changes: 30 additions & 0 deletions docs/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
### Building on macOS
1. Homebrew is needed to install PyGObject. [Get it from the Homebrew website.](https://brew.sh)
2. Clone this repository.
```
git clone https://github.com/zevlee/passphraser.git
```
3. Enter the `macos` directory.
```
cd passphraser/macos
```
4. Run `bootstrap.sh` to install any missing dependencies.
```
./bootstrap.sh
```
5. Run `build.sh`.
```
./build.sh
```
Enable code signing by adding the Common Name of the certificate as the first argument. Without this, adhoc signing will be used.
```
./build.sh "Developer ID Application: Name Here (TEAMIDHERE)"
```
Enable notarization by also adding the name of a stored keychain profile.
```
./build.sh "Developer ID Application: Name Here (TEAMIDHERE)" "keychain-profile-here"
```
Notarization can alternatively be enabled by adding Apple ID, Team ID, and an app-specific password as subsequent arguments.
```
./build.sh "Developer ID Application: Name Here (TEAMIDHERE)" "appleid@here.com" "TEAMIDHERE" "pass-word-goes-here"
```
27 changes: 27 additions & 0 deletions docs/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
### Building on Windows
1. MSYS2 is needed to build on Windows. [Get it from the MSYS2 website.](https://www.msys2.org/)
2. Go to your folder for MSYS2 and run `mingw64.exe`. The following commands will be executed in the console that appears.
3. Install git.
```
pacman -S git
```
4. Clone this repository.
```
git clone https://github.com/zevlee/passphraser.git
```
5. Enter the `windows` directory.
```
cd passphraser/windows
```
6. Run `bootstrap.sh` to install any missing dependencies.
```
./bootstrap.sh
```
7. Run `build.sh`.
```
./build.sh
```
Create a portable executable by adding the portable option
```
./build.sh portable
```