Skip to content

Commit 802268d

Browse files
committed
Update readme
1 parent def443b commit 802268d

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,52 @@
11
# Software Renderer
22

3-
This is a shader-based software renderer written from scratch. It is written in C89 with minimal dependencies, available for Windows, macOS, and Linux.
3+
This is a shader-based software renderer written from scratch. It is written
4+
in C89 with minimal dependencies, available for Windows, macOS, and Linux.
45

56
## Features
67

78
* Cross-platform (Windows, macOS, and Linux)
9+
* Minimal dependencies
810
* Shader-based
911
* Real-time
10-
* Blinn–Phong shading
12+
* Blinn–Phong reflection model
1113
* Physically based rendering (PBR)
1214
* Metalness workflow
1315
* Specular workflow
1416
* Image-based lighting (IBL)
1517
* Normal mapping
1618
* Shadow mapping
17-
* Depth testing
18-
* Alpha testing
19-
* Blending
20-
* Clipping
21-
* Back-face culling
22-
* Perspective-correct interpolation
23-
* Skybox
24-
* Texturing (2D, Cubemap)
19+
* Cubemapped skybox
2520
* Skeletal animation
2621
* Orbit camera control
27-
* Mesh loading (obj, glTF)
22+
* Back-face culling
23+
* Homogeneous clipping
24+
* Perspective-correct interpolation
25+
* Depth testing
26+
* Alpha testing
27+
* Alpha Blending
28+
* Mesh loading (obj, gltf)
2829
* Image loading (tga, hdr)
2930

3031
## Download
3132

32-
[Binaries](https://github.com/zauonlok/renderer/releases) for Windows, macOS, and Linux are available.
33+
[Binaries](https://github.com/zauonlok/renderer/releases) for Windows, macOS,
34+
and Linux are available.
3335

3436
## Build
3537

36-
To build the renderer from source, a C89 compiler and development files for your window system are required.
38+
To build the renderer from source, a C89 compiler and development files for
39+
your window system are required.
3740

3841
### Windows
3942

40-
Install [Visual Studio](https://visualstudio.microsoft.com/downloads/) and run `build_win32.bat`.
43+
Install [Visual Studio](https://visualstudio.microsoft.com/downloads/) and
44+
run `build_win32.bat`.
4145

4246
### macOS
4347

44-
Install [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) and run `build_macos.sh`.
48+
Install [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) and
49+
run `build_macos.sh`.
4550

4651
### Linux
4752

@@ -69,7 +74,9 @@ sudo zypper install gcc libX11-devel
6974

7075
### Launch
7176

72-
If the renderer is launched without arguments, one of the available scenes (see below) will be chosen randomly. To display a specific scene, additional arguments should be supplied. The command line syntax is:
77+
If the renderer is launched without arguments, one of the available scenes
78+
(see below) will be chosen randomly. To display a specific scene, additional
79+
arguments should be supplied. The command line syntax is:
7380

7481
```
7582
Viewer [test_name [scene_name]]
@@ -85,8 +92,8 @@ Viewer [test_name [scene_name]]
8592

8693
## Samples
8794

88-
| Scene | Screenshot | Command |
89-
| -------------------------------------------- | --------------------------------------------------------------- | -------------------------- |
95+
| Scene | Screenshot | Command |
96+
| -------------------------------------------- | --------------------------------------------------------------- | ------------------------ |
9097
| [Azura](assets/azura/README.md) | <img src="assets/azura/screenshot.png" width="540"> | `Viewer blinn azura` |
9198
| [Centaur](assets/centaur/README.md) | <img src="assets/centaur/screenshot.png" width="540"> | `Viewer blinn centaur` |
9299
| [Craftsman](assets/craftsman/README.md) | <img src="assets/craftsman/screenshot.png" width="540"> | `Viewer blinn craftsman` |

0 commit comments

Comments
 (0)