Skip to content

update the README format a bit #326

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

Merged
merged 1 commit into from
Apr 9, 2025
Merged

update the README format a bit #326

Show file tree
Hide file tree
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
22 changes: 2 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,15 @@
# ret

<img src="https://github.com/rerrorctf/ret/assets/93072266/5a998dbb-5730-4b10-9636-45e35e9fe77e" alt="rounding error ctf team logo" width="400"/>

This tool helps you solve ctf tasks by automating workflow and basic analysis and providing useful utilities.

<img src="https://github.com/rerrorctf/ret/assets/93072266/5a998dbb-5730-4b10-9636-45e35e9fe77e" alt="rounding error ctf team logo" width="150"/>

## 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
```
Expand Down
20 changes: 2 additions & 18 deletions commands/readme.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,16 @@ func ReadmeHelp() string {
func Readme(args []string) {
fmt.Printf("# ret\n\n")

fmt.Printf("<img src=\"https://github.com/rerrorctf/ret/assets/93072266/5a998dbb-5730-4b10-9636-45e35e9fe77e\" alt=\"rounding error ctf team logo\" width=\"400\"/>\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("<img src=\"https://github.com/rerrorctf/ret/assets/93072266/5a998dbb-5730-4b10-9636-45e35e9fe77e\" alt=\"rounding error ctf team logo\" width=\"150\"/>\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")
Expand Down