Skip to content

Commit

Permalink
Minor edits to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rswinkle committed Jun 18, 2024
1 parent cd673b5 commit 2ae9df5
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ to other languages. Keeping the library small with few or no dependencies only e
All that said, if I were ever going to actually write a real/large 3D application or game I would probably use C++ for the benefits
like operator overloading, just like I do with the majority of the demos. Choosing a language for a large user level application
is an entirely different animal from choosing one for a library. On the other hand, there are still reasons to use C, including objective
reasions like compilation time and binary size, but most are more subjective/personal. On the other other hand, I don't think the
reasons like compilation time and binary size, but most are more subjective/personal. On the other other hand, I don't think the
["It Runs Doom"](https://knowyourmeme.com/memes/it-runs-doom) meme would exist if it were written in C++ and who doesn't want their
application to run on toasters and oscilloscopes 3 decades after it was released?

Expand Down Expand Up @@ -192,7 +192,7 @@ If you just want to do a quick test that it compiles and runs:
...
All tests passed

You can look in testing/test_output to see the png's generated by `run_tests` which are compared with those in testing/expected_output.
You can look in `testing/test_output` to see the png's generated by `run_tests` which are compared with those in `testing/expected_output`.
For each test that fails, two files will be generated: testname_diff.png and testname_diff.txt. The first is a black image with any pixels
that didn't match the expected output being white. The second lists the exact pixel values and their expected values in the format:

Expand Down Expand Up @@ -239,7 +239,8 @@ Directory Structure
- `textures`: All textures used in any program in the repo
- `src`: Contains the actual source files of `portablegl.h` which are amalgamated with `generate_gl_h.py`
- `testing`: Contains a more formal regression and performance test suite
- `expected_output`: The expected output frames for each of the regression tests
- `expected_output`: The expected output frames for the regression tests (`run_tests`)
- `test_output`: The output of the regression tests (see Building section)
- `portablegl.h` : Current dev version of PortableGL

While I try not to introduce bugs, they do occasionally slip in, as well as (rarely) breaking
Expand Down

0 comments on commit 2ae9df5

Please sign in to comment.