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

Suggestion: Add a "quickstart" section to README #1422

Open
oseiskar opened this issue Jan 7, 2023 · 0 comments
Open

Suggestion: Add a "quickstart" section to README #1422

oseiskar opened this issue Jan 7, 2023 · 0 comments

Comments

@oseiskar
Copy link

oseiskar commented Jan 7, 2023

Could be as simple as

mkdir build
cd build
cmake ..
make -j10
../bin/ytrace --scene ../tests/materials1/materials1.json
# output is written to bin/out.png

This would help prospective users to kick the tires of the library without browsing through the source or CMakeFiles.

I am very positively surprised that the above worked out-of-the-box on my machine with zero compiler warnings or OpenGL issues, and the output looked nice too. Great work!

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

No branches or pull requests

1 participant