Skip to content

Commit

Permalink
remove manifests files, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dwu359 committed Oct 19, 2023
1 parent d67e28d commit 64ede43
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 116 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# dlp-cli installation

## Unix installation (Linux, MacOS, WSL)

Step 0: If on Windows, install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
## Unix installation (Linux, MacOS)

Step 1: Install homebrew. You can find installation instructions for homebrew at [https://brew.sh/](https://brew.sh/)

Step 2: Run `brew tap DSGT-DLP/dlp-cli` in the terminal

Step 3: Run `brew install dlp-cli` in the terminal

## Windows installation (Do this if WSL doesn't work)
## Windows installation

Step 1: If you don't have the `dlp-cli` submodule, run `git submodule init dlp-cli` in the project directory. Then run `git submodule update`. If it says that you are in a detached HEAD state, cd to the dlp-cli submodule directory and `git checkout main`.
Step 1: Install scoop. You can find installation instructions for scoop at [https://scoop.sh/](https://scoop.sh/)

Step 2: Run `winget settings --enable LocalManifestFiles` as administrator. Then, in the project directory, run `winget install -m dlp-cli/manifests/d/DSGT-DLP/dlp-cli/{version}`. Replace `{version}` with the version number that you want (typically the latest version).
Step 2: Run `scoop bucket add scoop-dlp-cli https://github.com/DSGT-DLP/scoop-dlp-cli.git` in the terminal

Step 3: Add the path to the install location to your PATH environment variable (somewhere within `%localappdata%\microsoft\winget\packages`, may need file explorer to find the exact folder)
Step 3: Run `scoop install scoop-dlp-cli/dlp-cli` in the terminal

## Usage

Run `dlp-cli` in DLP's project directory in the terminal

## Cli Development Info
## READ IF YOU WANT TO CONTRIBUTE TO THE dlp-cli:

Step 1: If you don't have the `dlp-cli` submodule, run `git submodule init dlp-cli` in the project directory. Then run `git submodule update`. If it says that you are in a detached HEAD state, cd to the dlp-cli submodule directory and `git checkout main`.

Run cli in debug mode with `go run main.go`
Step 2: Run cli in debug mode with `go run main.go`

Make sure to add package paths of all files as imports in main.go
Step 3: Make sure to add package paths of all files as imports in main.go

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions manifests/d/DSGT-DLP/dlp-cli/0.0.11/DSGT-DLP.dlp-cli.yaml

This file was deleted.

34 changes: 0 additions & 34 deletions manifests/d/DSGT-DLP/dlp-cli/0.0.9/DSGT-DLP.dlp-cli.installer.yaml

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions manifests/d/DSGT-DLP/dlp-cli/0.0.9/DSGT-DLP.dlp-cli.yaml

This file was deleted.

0 comments on commit 64ede43

Please sign in to comment.