Skip to content

Commit

Permalink
README: Minor grammar and readability improvements (#430)
Browse files Browse the repository at this point in the history
  • Loading branch information
@hoijui
hoijui committed Jan 13, 2024
1 parent 5e82c7c commit d7bedd2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A OpenGL/WebGL/OpenGL ES renderer which seeks to make graphics simple but still
- makes it possible to combine high-level features with custom low-level implementations for example custom shaders.
- tries to do stuff in a few simple lines of code.
- aims to be as explicit as possible so there is no surprises for you - no hidden magic.
- targets both desktop, web and mobile.
- targets desktop, web and mobile.

`three-d` can for example be used for

Expand Down Expand Up @@ -69,9 +69,9 @@ The crate consist of three main modules for drawing, `context`, `core` and `rend
| Module | Description |
| :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`context`](https://docs.rs/three-d/0/three_d/context/) | Low-level rendering module - requires a solid understanding of graphics concepts. Gives you complete control over both setup and rendering. |
| [`core`](https://docs.rs/three-d/0/three_d/core/) | Mid-level rendering module - requires at least some knowledge about graphics concepts. Use this if you want to write your own shaders and but don't want to spend time on setup and error handling. Can be combined with low-level functionality in the `context` module. |
| [`core`](https://docs.rs/three-d/0/three_d/core/) | Mid-level rendering module - requires at least some knowledge about graphics concepts. Use this if you want to write your own shaders, but don't want to spend time on setup and error handling. Can be combined with low-level functionality in the `context` module. |
| [`renderer`](https://docs.rs/three-d/0/three_d/renderer/) | High-level rendering module - requires no knowledge about graphics concepts. Use this if you just want to draw something. Features include functionality to rendering different types of standard objects with different types of shading. Can be combined seamlessly with the mid-level features in the `core` module as well as functionality in the `context` module. |
| [`window`](https://docs.rs/three-d/0/three_d/window/) (requires the `"window"` feature) | Window functionality on cross-platform native and web which primarily is provided to make it easy to get started. In some cases it is desirable to replace the default `Window` with a custom [winit](https://github.com/rust-windowing/winit) window as exemplified in the `winit_window` example. However, this module can also be replaced entirely by anything that provides an OpenGL or WebGL2 graphics context, for example [winit](https://github.com/rust-windowing/winit) and [glutin](https://github.com/rust-windowing/glutin), [wasm-bindgen](https://rustwasm.github.io/wasm-bindgen/introduction.html) or [eframe](https://github.com/emilk/egui/tree/master/crates/eframe). |
| [`window`](https://docs.rs/three-d/0/three_d/window/) (requires the `"window"` feature) | Window functionality on cross-platform native and web, which primarily is provided to make it easy to get started. In some cases, it is desirable to replace the default `Window` with a custom [winit](https://github.com/rust-windowing/winit) window as exemplified in the `winit_window` example. However, this module can also be replaced entirely by anything that provides an OpenGL or WebGL2 graphics context, for example [winit](https://github.com/rust-windowing/winit) and [glutin](https://github.com/rust-windowing/glutin), [wasm-bindgen](https://rustwasm.github.io/wasm-bindgen/introduction.html) or [eframe](https://github.com/emilk/egui/tree/master/crates/eframe). |

In addition, the [three-d-asset](https://github.com/asny/three-d-asset) crate enables loading, deserializing, serializing and saving 3D assets, for example 3D models, textures etc. Please make sure to use the same version of [three-d-asset](https://github.com/asny/three-d-asset) as defined in the `Cargo.toml`.

Expand All @@ -81,7 +81,7 @@ In addition, the [three-d-asset](https://github.com/asny/three-d-asset) crate en

Several examples covering most features can be found in the [examples folder](https://github.com/asny/three-d/tree/master/examples).

Here you will also find an overview of the examples, build instructions and links where you can try out each example on web.
Here you will also find an overview of the examples, build instructions and links to the web version of the examples.

The examples that fit with a specific release can be found in the branch for that release, ie. the examples for the [0.9 release](https://crates.io/crates/three-d/0.9.0) can be found in the [0.9 branch](https://github.com/asny/three-d/tree/0.9/examples).

Expand All @@ -97,11 +97,11 @@ The examples that fit with a specific release can be found in the branch for tha

Most parts are relatively stable, but do expect regular breaking changes until a 1.0.0 release.
The master branch is work in progress, so if you want to avoid too many breaking changes and features not working, use a released version.
If possible and feasible, functionality will be deprecated in one release before it is removed in the next release.
If possible and feasible, functionality will be deprecated in one release, before it is removed in the next release.

### Contributing

Feature requests and bug reports are more than welcome, just open an issue or start a discussion. Contributions are highly appreciated, please feel free to reach out or simply create a pull request against the [master branch](https://github.com/asny/three-d/tree/master). To avoid waste of time, please reach out before making major changes.
Feature requests and bug reports are more than welcome; just open an issue or start a discussion. Contributions are highly appreciated; please feel free to reach out or simply create a pull request against the [master branch](https://github.com/asny/three-d/tree/master). To avoid waste of time, please reach out before making major changes.

### Sponsors

Expand Down

0 comments on commit d7bedd2

Please sign in to comment.