Skip to content
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.

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

Update and reformat README #400

Merged
merged 7 commits into from
May 9, 2024
Merged

Update and reformat README #400

merged 7 commits into from
May 9, 2024

Conversation

KaBankz
Copy link
Contributor

@KaBankz KaBankz commented May 5, 2024

I've updated the install section for Homebrew to install from the git HEAD, instead of the latest release tag. ref: #204

I've also reformatted and changed the verbage of the README to be more consice and clear.
The README now follows markdownlint rules, and best practices for markdown.

I made sure to not change the actual meaning of the README's contents, just the way it was presented.

If you feel like the changes are not appropriate, please let me know and I'll revert them, keeping only the updated Homebrew install instructions.

If you have any questions or suggestions, please let me know.

KaBankz added 3 commits May 5, 2024 14:50
The entire README has been reformatted following
the guidelines of `markdownlint`

The verbage has been changed to be more clear and
concise. The information has not been changed
@b3nj5m1n
Copy link
Owner

b3nj5m1n commented May 7, 2024

In general, I think these are great changes, thank you very much!

I'm a little hesitant to put the big homebrew section before the instructions for manual installation, since most people are probably not using homebrew.

I also think the "Available commands" section for xdgnj should be higher up, I think putting it right after the "You can download the xdgnj executable from the releases page." line makes more sense, since (I'm assuming) most people are using the executable from the releases page, and not building it themselves.

If you could address those two things, that would be great, otherwise this looks good!

@KaBankz
Copy link
Contributor Author

KaBankz commented May 7, 2024

Thanks for the feedback, I'm glad you like the changes!

I'm a little hesitant to put the big homebrew section before the instructions for manual installation, since most people are probably not using homebrew.

No problem, I'll bump the manual installation instructions to the top.

Any thoughts on adding the commands to that as well? So, something like this:

### Manual Installation

Clone the repository, then run the [`./xdg-ninja.sh`](./xdg-ninja.sh) script.

```sh
git clone https://github.com/b3nj5m1n/xdg-ninja
cd xdg-ninja
./xdg-ninja.sh
```

This will run every test in the default configuration.

Also, what about including a section like this, under the rest of the installation methods:

### Other Package Managers

`xdg-ninja` is avaliable in many package managers.

The full list is available on the [repology page](https://repology.org/project/xdg-ninja/versions).

Follow the instructions for your package manager to install `xdg-ninja`.

I also think the "Available commands" section for xdgnj should be higher up, I think putting it right after the "You can download the xdgnj executable from the releases page." line makes more sense, since (I'm assuming) most people are using the executable from the releases page, and not building it themselves.

I purposefully moved it lower because it flows better:

Installation Methods -> Available Commands

Rather than:

Installation Method 1 -> Available Commands -> Installation Method 2 -> etc...

But, if that's your preference, then I can move it back up.

Thoughts on adding instructions on how to download from the releases? Something like this:

#### Prebuilt Binaries

> [!IMPORTANT]
> The binaries only run on x86_64 Linux systems.

```sh
curl -fsSL -o xdgnj https://github.com/b3nj5m1n/xdg-ninja/releases/latest/download/xdgnj
chmod +x xdgnj
```

Thanks!

@b3nj5m1n
Copy link
Owner

b3nj5m1n commented May 7, 2024

I'm on board with all of that!

@KaBankz
Copy link
Contributor Author

KaBankz commented May 7, 2024

Awesome, just to clarify, you want the "Available commands" section moved back up or keep it as it is?

@b3nj5m1n
Copy link
Owner

b3nj5m1n commented May 8, 2024

I'd prefer it higher up, I totally get where you're coming from, I just think most users would probably like to get an overview of what the utility is actually good for before going through specifics.

Also add documentation on how to download from releases
@KaBankz
Copy link
Contributor Author

KaBankz commented May 8, 2024

Absolutely, check it now, I've moved it back to its original position.

Also, if you have anything else you want added removed or changed, let me know.

@b3nj5m1n
Copy link
Owner

b3nj5m1n commented May 9, 2024

Awesome, thank you very much again!

@b3nj5m1n b3nj5m1n merged commit 9e9350a into b3nj5m1n:main May 9, 2024
@KaBankz KaBankz deleted the update-readme branch May 9, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants