Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
paroj committed Sep 21, 2024
1 parent 26ca9fe commit ac34b81
Showing 1 changed file with 32 additions and 38 deletions.
70 changes: 32 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
[![Join the chat at https://gitter.im/OGRECave/ogre](https://badges.gitter.im/OGRECave/ogre.svg)](https://gitter.im/OGRECave/ogre?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Patreon](https://img.shields.io/badge/patreon-donate-blue.svg)](https://www.patreon.com/ogre1)

![](Other/ogre_header.png)
![](Other/ogre_header.svg)

## OGRE - scene-oriented, flexible 3D engine

## Summary
**OGRE** (Object-Oriented Graphics Rendering Engine) is a
scene-oriented, flexible 3D engine written in C++ designed to make it
easier and more intuitive for developers to produce games and demos
Expand All @@ -14,40 +15,14 @@ using the underlying system libraries like Direct3D and OpenGL and
provides an interface based on world objects and other intuitive
classes.

| Build | Status |
|-------|-----------------|
| Linux, OSX, Android, iOS | [![CI Build](https://github.com/OGRECave/ogre/workflows/CI%20Build/badge.svg?branch=master)](https://github.com/OGRECave/ogre/actions?query=branch%3Amaster) |
| MSVC | [![Build status](https://ci.appveyor.com/api/projects/status/kcki7y0n1ahrggdw/branch/master?svg=true)](https://ci.appveyor.com/project/paroj/ogre-bsrh7/branch/master) |

### Citing
If you use Ogre in your research, please cite it like this:

```bibtex
@misc{rojtberg2024ogre,
author = "{Rojtberg, Pavel and Rogers, David and Streeting, Steve and others}",
title = "OGRE scene-oriented, flexible 3D engine",
year = "2001 -- 2024",
howpublished = "\url{https://www.ogre3d.org/}",
}
```

## Index Of Contents
* [What's New?](Docs/14-Notes.md)
A summary of the new and altered features in this release.
* [Building the core OGRE libraries](https://ogrecave.github.io/ogre/api/latest/building-ogre.html)
If you're using the full source release, this will help you build it. If you're using a precompiled SDK then most of the work has already been done for you, and you should use the sample projects to see how to compile your own code against OGRE.
* [The OGRE Manual](https://ogrecave.github.io/ogre/api/latest/manual.html)
A high-level guide to the major parts of the engine and script reference.
* [API Reference](https://ogrecave.github.io/ogre/api/latest/)
The full OGRE API documentation, as generated from the (heavily!) commented source.
* [The OGRE Tutorials](https://ogrecave.github.io/ogre/api/latest/tutorials.html)
A gold mine of tutorials, tips and code snippets which will help you get up to speed with the engine.
[Try it](#try-it) -
[Building](https://ogrecave.github.io/ogre/api/latest/building-ogre.html) -
[Tutorials](https://ogrecave.github.io/ogre/api/latest/tutorials.html) -
[Manual](https://ogrecave.github.io/ogre/api/latest/manual.html) -
[What's New?](Docs/14-Notes.md) -
[Who is using it?](#who-is-using-it) -
[Community Support](http://forums.ogre3d.org/)

## Try it
* [Online Emscripten Demo](https://ogrecave.github.io/ogre/emscripten/)
* [Windows Demos Distribution](https://dl.cloudsmith.io/public/ogrecave/ogre/raw/versions/master/ogre-sdk-master-msvc142-x64.zip)
* [Linux Snap Package](https://snapcraft.io/ogre)
* [Android App on F-Droid](https://f-droid.org/packages/org.ogre.browser/)

## Features

Expand All @@ -73,6 +48,12 @@ For an exhaustive list, see the [features page](http://www.ogre3d.org/about/feat
|----|----|
| ![](Other/screenshots/imgui.jpg) | ![](Other/screenshots/bullet.webp) |

## Try it
* [Online Emscripten Demo](https://ogrecave.github.io/ogre/emscripten/)
* [Windows Demos Distribution](https://dl.cloudsmith.io/public/ogrecave/ogre/raw/versions/master/ogre-sdk-master-msvc142-x64.zip)
* [Linux Snap Package](https://snapcraft.io/ogre)
* [Android App on F-Droid](https://f-droid.org/packages/org.ogre.browser/)

## Who is using it?

**Open Source**
Expand All @@ -88,15 +69,28 @@ For an exhaustive list, see the [features page](http://www.ogre3d.org/about/feat
- [Torchlight II](http://store.steampowered.com/app/200710/Torchlight_II/)
- [Battlezone 98 Redux](http://store.steampowered.com/app/301650/Battlezone_98_Redux/)

## Citing
If you use Ogre in your research, please cite it like this:

```bibtex
@misc{rojtberg2024ogre,
author = "{Rojtberg, Pavel and Rogers, David and Streeting, Steve and others}",
title = "OGRE scene-oriented, flexible 3D engine",
year = "2001 -- 2024",
howpublished = "\url{https://www.ogre3d.org/}",
}
```

## Contributing
We welcome all contributions to OGRE, be that new
plugins, bugfixes, extensions, tutorials, documentation, example
applications, artwork or pretty much anything else! If you would like
to contribute to the development of OGRE, please create a [pull request](https://github.com/OGRECave/ogre/pulls).

## Getting Support
Please use our [community support forums](http://forums.ogre3d.org/) if you need help or
think you may have found a bug.
| Build | Status |
|-------|-----------------|
| Linux, OSX, Android, iOS | [![CI Build](https://github.com/OGRECave/ogre/workflows/CI%20Build/badge.svg?branch=master)](https://github.com/OGRECave/ogre/actions?query=branch%3Amaster) |
| MSVC | [![Build status](https://ci.appveyor.com/api/projects/status/kcki7y0n1ahrggdw/branch/master?svg=true)](https://ci.appveyor.com/project/paroj/ogre-bsrh7/branch/master) |

## Licensing
Please see the [full license documentation](Docs/License.md) for details.

0 comments on commit ac34b81

Please sign in to comment.