millironx/sc2-sequencing
1
0
Fork 0
mirror of https://github.com/MillironX/sc2-sequencing.git synced 2024-12-22 03:08:17 +00:00
Code Issues Releases Packages Activity

Cleanup main README

Browse source
This commit is contained in:
Thomas A. Christensen II 2021-04-13 13:58:00 -06:00
parent f4c8b4da97
commit 9f715bf5cd
Signed by: millironx
GPG key ID: 139C07724802BC5D
1 changed files with 22 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -2,24 +2,29 @@
Bioinformatics scripts for use at the Wyoming Public Health Laboratory.
These scripts have various purposes, uses, and instructions. The only unifying thing about them is that they were all written for WPHL. Please check the `README` file in each directory for more detailed instructions.
These scripts have various purposes, uses, and instructions. The only unifying
thing about them is that they were all written for WPHL. Please check the
`README` file in each directory for more detailed instructions.
## Encryption
**NOTICE:** Some files in this repository are encrypted using [git-crypt](https://github.com/AGWA/git-crypt). git-crypt works on a repository-wide basis, meaning that decryption must occur on the entire repository.
**NOTICE:** Some files in this repository are encrypted using
[git-crypt](https://github.com/AGWA/git-crypt). git-crypt works on a
repository-wide basis, meaning that decryption must occur on the entire
repository.
### Installing git-crypt
#### Ubuntu, Debian, etc.
```bash
$ sudo apt-get install git-crypt -y
sudo apt-get install git-crypt -y
```
#### Fedora, CentOS, RHEL, etc.
```bash
$ sudo yum install git-crypt -y
sudo yum install git-crypt -y
```
#### MacOS
@ -27,22 +32,29 @@ $ sudo yum install git-crypt -y
Install [Homebrew](https://brew.sh/) first. Then
```bash
$ brew install git-crypt
brew install git-crypt
```
#### Windows
There are no official git-crypt builds for Windows. I repeat, **git-crypt does not exist for Windows** regardless of what others may tell you. If possible, you may use the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10), but you cannot use native git-crypt.
There are no official git-crypt builds for Windows. I repeat, **git-crypt does
not exist for Windows** regardless of what others may tell you. If possible, you
may use the [Windows Subsystem for
Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10), but you
cannot use native git-crypt.
### Decrypting the repository
Encryption is GPG-based. If your GPG key has been added to the repository (you know if you have access), then run
Encryption is GPG-based. If your GPG key has been added to the repository (you
know if you have access), then run
```bash
$ git clone https://github.com/MillironX/wphl-bioinformatics.git && cd wphl-bioinformatics
$ git-crypt unlock
git clone https://github.com/MillironX/wphl-bioinformatics.git && cd wphl-bioinformatics
git-crypt unlock
```
The files will now be decrypted and can be usable.
If you need to copy your GPG keys to a new machine to be able to decrypt the files, follow the instructions at https://www.phildev.net/pgp/gpg_moving_keys.html under "Copy Just Your Keys."
If you need to copy your GPG keys to a new machine to be able to decrypt the
files, follow the instructions at
https://www.phildev.net/pgp/gpg_moving_keys.html under "Copy Just Your Keys."