updated readme

This commit is contained in:
mellodoot 2023-05-10 23:51:26 +01:00
parent 9853be9003
commit 848b7a57a6
No known key found for this signature in database
GPG key ID: FDF03EEFB7BA59B6

View file

@ -1,5 +1,6 @@
# ipaddrgen 👩‍💻
### the funny ip address generator
## the funny ip address generator
a small cli program written in go that generates random ip addresses and "does things" to them.
@ -9,11 +10,11 @@ a small cli program written in go that generates random ip addresses and "does t
*legal disclaimer: no this isn't a "hacking" tool, it's a goofy piece of software that spits text out onto the screen and nothing more. I wholeheartedly encourage that this software be used in le funny hacking montage.*
# screenies 📸
## screenies 📸
![ipaddrgen in action](screenshots/v1term.png)
# use it! ✨
## use it! ✨
[download](https://github.com/mellodoot/ipaddrgen/releases/latest) whichever version is compatible with your OS (if such a version isn't listed, I'm so sorry!), then run it via your terminal!
@ -21,14 +22,14 @@ i.e. `./ipaddrgen-PLATFORM-ARCH`
for help with command-line arguments (for some fun customisation), try `./ipaddrgen -h`!
# build it! 📀
## build it! 📀
### requirements:
### requirements
- [go](https://go.dev/) (currently using 1.17.6)
- that's about it
### how:
### how
windows: `go build -o ./bin/ipaddrgen.exe ./src`