Skip to content

Commit

Permalink
Merge pull request #37 from freedomofpress/readme-updates
Browse files Browse the repository at this point in the history
readme: improvements to documentation, add gif of diagrams
  • Loading branch information
conorsch authored May 2, 2019
2 parents 307b681 + da78bd6 commit dd81f49
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# SecureDrop Debian Packaging

This repository contains the packaging files and tooling for building Debian packages for projects for the alpha [SecureDrop Workstation](https://github.com/freedomofpress/securedrop-workstation) based on Qubes OS. Packages are placed on `apt-test-qubes.freedom.press` for installation in Debian-based TemplateVMs. These packages are not yet ready for use in a production environment.
![Packaging Workflow](images/diagram.png)

## Packaging a Python-based SecureDrop project

This includes `securedrop-proxy` and `securedrop-client`.
The following process is used for Python-based projects for the Qubes SecureDrop Workstation, namely, `securedrop-proxy` and `securedrop-client`:

![gif explaining what is committed where](images/securedrop-pip-mirror.gif)

The following diagram shows the makefile targets/scripts in this repository, the produced artifacts and the locations where these artifacts are stored:

![Packaging Workflow](images/diagram.png)

### Packaging Dependencies

Expand Down Expand Up @@ -51,10 +56,6 @@ Checkout the release tag for the project:
git checkout 0.x.y
```

If you are making any changes in the `Pipfile`, remember
to add all recursive dependencies directly as dependency
under `[packages]`.

Generate a tarball to be used in the build process:

```
Expand Down
Binary file added images/securedrop-pip-mirror.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dd81f49

Please sign in to comment.