Skip to content

Update README.md to include cargo install command #39

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

Open
larsfroelich wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md to include cargo install command #39

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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,12 @@ I've created issues for some of the missing functionality. Most importantly more

For macOS, Linux or Windows install instructions, [please refer to the Readme in the postsack-native folder](postsack-native/Readme.md)

## Deploying to crates.io for `cargo install`
## Building from source with `cargo install`
Postsack is not yet deployed to crates.io (see reason below), but you can build and install it directly from the git repository using

`cargo install --git https://github.com/terhechte/postsack.git`

## Deploying to crates.io

One of the issues I ran into was that many of the emails I had received over the years were not
properly standards compliant. I forked [`email-parser`, email parser that Postsack is using](https://github.com/Mubelotix/email-parser/pull/11) in order to support all the weird issues I encountered. However,
Expand Down