diff --git a/README.md b/README.md index 09838be..fd1c651 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,15 @@ # ret -rounding error ctf team logo - This tool helps you solve ctf tasks by automating workflow and basic analysis and providing useful utilities. +rounding error ctf team logo + ## Installation You can get the latest binary from https://github.com/rerrorctf/ret/releases. -Here installation just means putting `ret` somewhere on your path. I like to make a symlink to it in `/usr/local/bin`. - -``` -$ sudo ln -s ./ret /usr/local/bin/ret -``` - -Other options are available and you may do whatever works best for you. - -### Installing Dependencies (Optional) - -some commands make opportunistic use of other tools and some won't work without them - ### Compiling (Optional) -First install `go` https://go.dev/dl/ by following the install instructions. - -You can use `go` in system repos but they tend to be fairly old and out of date. - -Now, the project root directory, you can simply do: - ``` $ go build ``` diff --git a/commands/readme.go b/commands/readme.go index 9c11a7b..fc61c14 100644 --- a/commands/readme.go +++ b/commands/readme.go @@ -23,32 +23,16 @@ func ReadmeHelp() string { func Readme(args []string) { fmt.Printf("# ret\n\n") - fmt.Printf("\"rounding\n\n") - fmt.Printf("This tool helps you solve ctf tasks by automating workflow and basic analysis and providing useful utilities.\n\n") + fmt.Printf("\"rounding\n\n") + fmt.Printf("## Installation\n\n") fmt.Printf("You can get the latest binary from https://github.com/rerrorctf/ret/releases.\n\n") - fmt.Printf("Here installation just means putting `ret` somewhere on your path. I like to make a symlink to it in `/usr/local/bin`.\n\n") - - fmt.Printf("```\n$ sudo ln -s ./ret /usr/local/bin/ret\n```\n\n") - - fmt.Printf("Other options are available and you may do whatever works best for you.\n\n") - - fmt.Printf("### Installing Dependencies (Optional)\n\n") - - fmt.Printf("some commands make opportunistic use of other tools and some won't work without them\n\n") - fmt.Printf("### Compiling (Optional)\n\n") - fmt.Printf("First install `go` https://go.dev/dl/ by following the install instructions.\n\n") - - fmt.Printf("You can use `go` in system repos but they tend to be fairly old and out of date.\n\n") - - fmt.Printf("Now, the project root directory, you can simply do:\n\n") - fmt.Printf("```\n$ go build\n```\n\n") fmt.Printf("This will produce the `ret` binary. This single file is all you need to use `ret`.\n\n")