scraping/skallwar.suckit
1
0
Fork 0
mirror of https://github.com/Skallwar/suckit.git synced 2026-09-10 07:16:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme: Add installation instructions (#62)

Browse source
This commit is contained in:
CohenArthur 2020-05-05 17:28:53 +02:00 committed by GitHub
parent 8dc6945c3c
commit dc57581baa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -35,6 +35,31 @@ A common use case could be the following:
[![asciicast](https://asciinema.org/a/17XpBXaZhpIX41w7nRF6i3M9y.svg)](https://asciinema.org/a/17XpBXaZhpIX41w7nRF6i3M9y)
# Installation
As of right now, `SuckIT` does not work on Windows.
To install it, you need to have Rust installed.
* Check out [this link](https://www.rust-lang.org/learn/get-started) for
instructions on how to install Rust.
* Then, download the `suckit` repository by cloning it or downloading a zipped
version of it and enter the directory.
```shell
git clone https://github.com/skallwar/suckit
cd suckit
```
* You can now install SuckIT!
```shell
cargo install --path .
```
* Now, run it from anywhere with the `suckit` command.
__Want to contribute ? Feel free to
[open an issue](https://github.com/Skallwar/suckit/issues/new) or
[submit a PR](https://github.com/Skallwar/suckit/compare) !__