Improve Installation Instructions

[Patitotective]

Hey 👋
I wanted to ask why are the installation instructions so complex if RaytracingAlgorithm is defined as a binary package in the nimble file (RaytracingAlgorithm.nimble) therefore requirements and building is done with nimble install RaytracingAlgorithm.
So the Requirements and Installation sections in the README can be replaced with just nimble install RaytracingAlgorithm.

Btw RaytracingAlgorithm seems really interesting and a cool project ❤️

[lorycontixd]

Hi, thank you very much for your appreciation!
If I understand your doubt correctly, it's because I wanted to give the freedom to the user to install the package both by fetching it using nimble, or by downloading the source code into the project folder. Any suggestion is always welcome!

[Patitotective]

Installation

Using nimble:

nimble install RaytracingAlgorithm

Directly from this repo:

nimble install https://github.com/lorycontixd/RaytracingAlgorithm

Cloning the repo and building it locally:

git clone https://github.com/lorycontixd/RaytracingAlgorithm
cd RaytracingAlgorithm
nimble build

[lorycontixd]

I think what you're saying makes perfect sense. I will fix it immediately.

[Patitotective]

I think what you're saying makes perfect sense. I will fix it immediately.

I just noticed that the last snippet should be:
Cloning the repo and installing it locally:

git clone https://github.com/lorycontixd/RaytracingAlgorithm
cd RaytracingAlgorithm
nimble install

[Patitotective]

Also I saw you added instructions to install an specific version but you're using wget to download a repo release when nimble already has a notation to do that

nimble install RaytracingAlgorithm@vX.Y.Z

[lorycontixd]

Also I saw you added instructions to install an specific version but you're using wget to download a repo release when nimble already has a notation to do that

nimble install RaytracingAlgorithm@vX.Y.Z

@Patitotective Doesn't that leave the user with a choice on how to install the package? As in an alternative.

[Patitotective]

Well, I don't see any situation where cloning an specific release could be useful (or usefuler than installing it with nimble) but sure :)

[Patitotective]

Also I see in most examples you use

nim cpp -d:relaese RaytracingAlgorithm.nim && ./RaytracingAlgorithm.out ...

While I think

RaytracingAlgorithm ...

Is enough

[lorycontixd]

Also I see in most examples you use

nim cpp -d:relaese RaytracingAlgorithm.nim && ./RaytracingAlgorithm.out ...

While I think

RaytracingAlgorithm ...

Is enough

It tells me that the command is not found, maybe I'm doing something wrong?

[Patitotective]

You should install (or build it and use ./RaytracingAlgorithm) RaytracingAlgorithm first (and have ~/.nimble/bin in your PATH)

[Patitotective]

Since you are using cligen you could make it even easier by copying the help message and pasting it in the readme.