Skip to content

Commit 32ece68

Browse files
committed
Some docs...
1 parent 4c56f22 commit 32ece68

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

doc/index.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
====
2+
Home
3+
====
4+
5+
Welcome to nimx
6+
--------------
7+
8+
**nimx** is a UI library written in `Nim<http://nim-lang.org>`_. Main features:
9+
10+
**Cross-platform**
11+
nimx can run on Windows, Linux, MacOS X, iOS, Android, and
12+
even `JavaScript<main.html>`_ in a web-browser!
13+
**Pure**
14+
nimx does not require any non-Nim dependencies except SDL2_ when compiling
15+
to native target. Compiling to JavaScript requires no non-Nim dependencies.
16+
This means that in order to use nimx all you need is SDL2_ and
17+
``requires nimx`` line in your `.nimble` file.
18+
**Hardware accelerated**
19+
nimx utilizes **OpenGL** renderer under the hood. This means you can embed
20+
nimx into existing **OpenGL** application or use it as a platform for your
21+
application with low-level **OpenGL** rendering. nimx exposes a zero-cost
22+
abstraction over **OpenGL** context to abstract away the difference between
23+
native **OpenGL** and **WebGL**. Despite being efficient for graphics
24+
intensive tasks nimx remains battery-friendly for mobile devices. The screen
25+
is not refreshed constantly when there is nothing to redraw.
26+
**Sleek**
27+
nimx provides instruments for hardware-accelerated resolution-independent
28+
vector graphics rendering which are used by nimx itself to
29+
render controls. Also nimx utilizes signed distance field TTF font rendering,
30+
resulting in better quality and resolution tolerance than conventional
31+
alpha-bitmap font rendering.
32+
33+
.. _SDL2: https://www.libsdl.org

nimx.nims

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ task docs, "Build documentation":
2020
exec "nim doc2 -d:js " & f
2121
except:
2222
discard
23+
for t, f in walkDir ".":
24+
if f.endsWith(".rst"):
25+
try:
26+
exec "nim rst2html " & f
27+
except:
28+
discard
29+
2330
cpFile "../test/main.html", "./main.html"
2431
cpDir "../test/res", "./res"
2532
mkDir "./nimcache"

0 commit comments

Comments
 (0)