Skip to content

Commit

Permalink
- Refreshed README:
Browse files Browse the repository at this point in the history 
  . HTML-ified the header (logo, badges, etc.)
  . Added a few more badges
  . Minor updates (getting started, first step, etc.)
  • Loading branch information
@iarwain
iarwain committed Nov 19, 2024
1 parent ba25f5d commit 0fbf7e6
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 37 deletions.
58 changes: 40 additions & 18 deletions README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1220,17 +1220,40 @@
.markdown-body .markdown-alert.markdown-alert-caution .markdown-alert-title {
color: var(--color-danger-fg);
}
</style><title>README</title></head><body><article class="markdown-body"><p><a href="https://orx-project.org/discord" rel="nofollow"><img src="https://camo.githubusercontent.com/a13c7499ccd751816ed1451320c87ae01e67869ae402012b739cf8ed2f47f486/68747470733a2f2f646973636f72646170702e636f6d2f6170692f6775696c64732f3532323136373733363832333138353431382f7769646765742e706e673f7374796c653d736869656c64" alt="Join the chat on https://orx-project.org/discord" data-canonical-src="https://discordapp.com/api/guilds/522167736823185418/widget.png?style=shield" style="max-width: 100%;"></a>
<a href="https://app.travis-ci.com/github/orx/orx" rel="nofollow"><img src="https://camo.githubusercontent.com/428c32cea49103f0e5e208f49b967cd1f98ceb9a5f79823ee7ad7acb86c3a6d0/68747470733a2f2f6170692e7472617669732d63692e636f6d2f6f72782f6f72782e7376673f6272616e63683d6d6173746572" alt="Travis build" data-canonical-src="https://api.travis-ci.com/orx/orx.svg?branch=master" style="max-width: 100%;"></a>
<a href="https://ci.appveyor.com/project/iarwain/orx" rel="nofollow"><img src="https://camo.githubusercontent.com/1cc7f48320f09b7e2c577e9d20c3b2b9c17fffd4a16931ce3c02aad4244d7478/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f616c776d34696c377831773667316f343f7376673d74727565" alt="Build status" data-canonical-src="https://ci.appveyor.com/api/projects/status/alwm4il7x1w6g1o4?svg=true" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx"><img src="https://camo.githubusercontent.com/0bc1431f0828c70c1a3604fe6e915787c6ea45a1022a8b22715253b797dd63e1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f6f72782f6f72782e737667" alt="Git Repo Size" data-canonical-src="https://img.shields.io/github/repo-size/orx/orx.svg" style="max-width: 100%;"></a></p>
<div class="markdown-heading"><h1 class="heading-element">Orx - Portable Game Engine (Version 1.15)</h1><a id="user-content-orx---portable-game-engine-version-115" class="anchor" aria-label="Permalink: Orx - Portable Game Engine (Version 1.15)" href="#orx---portable-game-engine-version-115"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
</style><title>README</title></head><body><article class="markdown-body"><p align="center">
<a href="https://orx-project.org" rel="nofollow"><img src="/C:/workspace/orx/logo.svg" alt="Orx Engine" width="400" height="auto" style="max-width: 100%;"></a>
<br>
<strong>A (HEAVILY) DATA-DRIVEN 2D GAME ENGINE</strong>
</p>
<p align="center">
<a href="/C:/workspace/orx/LICENSE"><img src="https://camo.githubusercontent.com/04f70e81985b272b0090b51a9adc1645492fea066eb78716351e8d5ac11fe3c2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6f72782f6f7278" alt="license" data-canonical-src="https://img.shields.io/github/license/orx/orx" style="max-width: 100%;"></a>
<a href="https://orx-project.org" rel="nofollow"><img src="https://camo.githubusercontent.com/8a4af2e34c57dde5f954dca6e40b51223dfa01dba5a49670ef1b7965474147d0/68747470733a2f2f696d672e736869656c64732e696f2f776562736974653f75726c3d68747470732533412532462532466f72782d70726f6a6563742e6f7267" alt="site" data-canonical-src="https://img.shields.io/website?url=https%3A%2F%2Forx-project.org" style="max-width: 100%;"></a>
<a href="https://orx-project.org/discord" rel="nofollow"><img src="https://camo.githubusercontent.com/a13c7499ccd751816ed1451320c87ae01e67869ae402012b739cf8ed2f47f486/68747470733a2f2f646973636f72646170702e636f6d2f6170692f6775696c64732f3532323136373733363832333138353431382f7769646765742e706e673f7374796c653d736869656c64" alt="discord" data-canonical-src="https://discordapp.com/api/guilds/522167736823185418/widget.png?style=shield" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx/forks"><img src="https://camo.githubusercontent.com/51c0ac6b0d1e4462c56c3e813763d89c39f5d4b79c37348d4b4bcf62beec3d59/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f6f72782f6f7278" alt="forks" data-canonical-src="https://img.shields.io/github/forks/orx/orx" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx"><img src="https://camo.githubusercontent.com/65af09547930ead61ab3f07daf20467e537e7d665175e6c8f4d48e017747f0a8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6f72782f6f7278" alt="stars" data-canonical-src="https://img.shields.io/github/stars/orx/orx" style="max-width: 100%;"></a>
</p>
<p align="center">
<a href="https://wiki.orx-project.org" rel="nofollow"><img src="https://camo.githubusercontent.com/c8c225d76fd37faa8289c0d2b8826722b528c81ec393977399817210f2dee694/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f706c6174666f726d732d77696e646f77732532302537432532306c696e75782532302537432532306d6163253230253743253230616e64726f6964253230253743253230696f732d726564" alt="platforms" data-canonical-src="https://img.shields.io/badge/platforms-windows%20%7C%20linux%20%7C%20mac%20%7C%20android%20%7C%20ios-red" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx/releases"><img src="https://camo.githubusercontent.com/ab9053b92c4edff02ed5a3467a714ae400ccffc26a6aa42dfb011ad2d6ce142a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6f72782f6f72783f636f6c6f723d6f72616e6765" alt="releases" data-canonical-src="https://img.shields.io/github/v/release/orx/orx?color=orange" style="max-width: 100%;"></a>
</p>
<p align="center">
<a href="https://app.travis-ci.com/github/orx/orx" rel="nofollow"><img src="https://camo.githubusercontent.com/428c32cea49103f0e5e208f49b967cd1f98ceb9a5f79823ee7ad7acb86c3a6d0/68747470733a2f2f6170692e7472617669732d63692e636f6d2f6f72782f6f72782e7376673f6272616e63683d6d6173746572" alt="build-travis" data-canonical-src="https://api.travis-ci.com/orx/orx.svg?branch=master" style="max-width: 100%;"></a>
<a href="https://ci.appveyor.com/project/iarwain/orx" rel="nofollow"><img src="https://camo.githubusercontent.com/1cc7f48320f09b7e2c577e9d20c3b2b9c17fffd4a16931ce3c02aad4244d7478/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f616c776d34696c377831773667316f343f7376673d74727565" alt="build-appveyor" data-canonical-src="https://ci.appveyor.com/api/projects/status/alwm4il7x1w6g1o4?svg=true" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx/commits/master"><img src="https://camo.githubusercontent.com/43b060b0e18931aad554f002569bb4ced14c1c0952a21ffeffff899e8ec570f4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f6f72782f6f72782f6d6173746572" alt="last-commit" data-canonical-src="https://img.shields.io/github/last-commit/orx/orx/master" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx/commits/master"><img src="https://camo.githubusercontent.com/62dabdaa96a35dfc32a239c360f93cc4d97f9281a1509694c53aa1f159a46ffc/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6d6d69742d61637469766974792f6d2f6f72782f6f72782f6d6173746572" alt="commit-activity" data-canonical-src="https://img.shields.io/github/commit-activity/m/orx/orx/master" style="max-width: 100%;"></a>
</p>
<p align="center">
<a href="https://github.com/orx/orx"><img src="https://camo.githubusercontent.com/0bc1431f0828c70c1a3604fe6e915787c6ea45a1022a8b22715253b797dd63e1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f6f72782f6f72782e737667" alt="repo-size" data-canonical-src="https://img.shields.io/github/repo-size/orx/orx.svg" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx/issues"><img src="https://camo.githubusercontent.com/374ac11fd0d1f0771a2d229557401d9f067c00d075c1e3725e7db6de6473e995/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6f72782f6f7278" alt="issues" data-canonical-src="https://img.shields.io/github/issues/orx/orx" style="max-width: 100%;"></a>
<a href="https://github.com/orx/orx/pulls"><img src="https://camo.githubusercontent.com/a5825e7dbe405ab05e9411a3414f5b0f6923457f8874da74de3fe8ed2c532040/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732d70722f6f72782f6f7278" alt="pull-requests" data-canonical-src="https://img.shields.io/github/issues-pr/orx/orx" style="max-width: 100%;"></a>
</p>
<div class="markdown-heading"><h1 class="heading-element">Orx (Version 1.15)</h1><a id="user-content-orx-version-115" class="anchor" aria-label="Permalink: Orx (Version 1.15)" href="#orx-version-115"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>This engine is licensed under the very permissive <a href="https://en.wikipedia.org/wiki/Zlib_License" rel="nofollow">zlib license</a> (i.e. it's free for any commercial or non-commercial use),
see the <a href="https://github.com/orx/orx/blob/master/LICENSE">LICENSE</a> file for details.</p>
<p>Email iarwain [at] orx-project.org to contact the author or come <a href="https://orx-project.org/discord" rel="nofollow">chat with us on Discord</a> if you have any questions, feedback or comments.</p>
<div class="markdown-heading"><h2 class="heading-element">Summary</h2><a id="user-content-summary" class="anchor" aria-label="Permalink: Summary" href="#summary"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p><a href="https://orx-project.org" rel="nofollow">Orx</a> is a 2D-oriented, data-driven, portable game engine focused primarily on ease of use and powerful features.
See below for a list of supported platforms.</p>
<p><a href="https://orx-project.org" rel="nofollow">Orx</a> is a heavily data-driven, 2D-oriented, portable game engine, focused primarily on ease of use and powerful features.
(See below for a list of supported platforms.)</p>
<p>This is a release candidate for orx v1.15. If you find any bugs,
please report them on the <a href="https://forum.orx-project.org" rel="nofollow">forum</a>, in the "Bug report - Feature request" board,
or via orx's <a href="https://github.com/orx/orx/issues">issue page/tracker</a>.</p>
Expand Down Expand Up @@ -1263,24 +1286,24 @@
<li>plugin system</li>
<li>screenshot capture tool (supports bmp, png, jpg, qoi, tga and dds)</li>
</ul>
<p>See <a href="https://orx-project.org/wiki" rel="nofollow">orx's wiki</a> for detailed information, including:</p>
<div class="markdown-heading"><h2 class="heading-element">Getting Started</h2><a id="user-content-getting-started" class="anchor" aria-label="Permalink: Getting Started" href="#getting-started"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>Check <a href="https://orx-project.org/wiki" rel="nofollow">orx's wiki</a> for detailed information, including:</p>
<ul>
<li>initial setup</li>
<li>beginner's guide</li>
<li>tools</li>
<li>samples</li>
<li>detailed tutorials (both official and community-made ones)</li>
</ul>
<p>See the <a href="https://github.com/orx/orx/tree/master/doc/html">doc/html</a> directory for the doxygen documentation of orx's API.
The documentation for the latest release version is <a href="https://orx-project.org/orx/doc/html" rel="nofollow">available here</a> at orx's homepage.</p>
<p>Check the <a href="/C:/workspace/orx/doc/html/index.html">doc/html</a> directory for orx's API doxygen documentation.</p>
<div class="markdown-heading"><h2 class="heading-element">Supported Platforms</h2><a id="user-content-supported-platforms" class="anchor" aria-label="Permalink: Supported Platforms" href="#supported-platforms"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The engine compiles and is tested for:</p>
<p>The engine compiles for, and is tested on:</p>
<ul>
<li>Linux (x86/x86-64 with codelite, codeblocks and GNU makefile)</li>
<li>Windows (x86/x86-64 with vs2017, vs2019 &amp; vs2022, x86/x86-64 mingw-w64 (14.2.0) with codelite, codeblocks and GNU makefile)</li>
<li>MacOS X (x86/x86-64 with xcode or x86/x86-64 with codelite, codeblocks and GNU makefile), version 10.6+</li>
<li>Android (Gradle build files, simulator &amp; device)</li>
<li>iOS (iPhone/iPod Touch/iPad, simulator &amp; device with xcode)</li>
<li>Android (NDK build files, simulator &amp; device)</li>
</ul>
<div class="markdown-heading"><h2 class="heading-element">Versions</h2><a id="user-content-versions" class="anchor" aria-label="Permalink: Versions" href="#versions"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>Those are not revision versions but link/run versions.
Expand Down Expand Up @@ -1391,12 +1414,11 @@
<li>build/project files</li>
</ul>
<div class="markdown-heading"><h2 class="heading-element">Compiling</h2><a id="user-content-compiling" class="anchor" aria-label="Permalink: Compiling" href="#compiling"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<div class="markdown-heading"><h3 class="heading-element">Important - first step:</h3><a id="user-content-important---first-step" class="anchor" aria-label="Permalink: Important - first step:" href="#important---first-step"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p><strong>If you just downloaded the <code>src</code> package or cloned orx with mercurial or git, you will need to run the setup.bat / setup.sh script
that's located at its root before being able to compile the engine.
This script will download all the needed dependencies and generate all the project files for your platform.
The script will then hook itself to mercurial/git and you shouldn't have to run it manually after subsequent pulls.</strong></p>
<p>The easiest way to learn how to compile your project using orx for a given platform
<div class="markdown-heading"><h3 class="heading-element">IMPORTANT - FIRST STEP:</h3><a id="user-content-important---first-step" class="anchor" aria-label="Permalink: IMPORTANT - FIRST STEP:" href="#important---first-step"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p><strong>If you just cloned orx's repository (or downloaded the <code>src</code> package), you will need to run the <code>setup.bat</code> / <code>setup.sh</code> script located at its root before being able to compile the engine.
This script will download all the required dependencies and generate the project files for your platform.
Finally, the script will hook itself to mercurial/git so you won't have to run it manually ever again.</strong></p>
<p>The easiest way to learn how to build your project using orx for a given platform
is to check <a href="https://wiki.orx-project.org" rel="nofollow">orx's wiki</a>.</p>
<p>The generated project files will contain 6 different configurations to build orx: <code>Debug</code>, <code>Profile</code> &amp; <code>Release</code> in both regular and <code>Core</code> flavors. Here's what they do:</p>
<ul>
Expand Down
Loading

0 comments on commit 0fbf7e6

Please sign in to comment.