Skip to content

Commit e1b64e7

Browse files
committed
github supports asciidoc markup, replace readme, add a bit more from overview page
1 parent 7fed22f commit e1b64e7

File tree

2 files changed

+78
-5
lines changed

2 files changed

+78
-5
lines changed

README.asciidoc

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
eLua - Lua for microcontrollers
2+
===============================
3+
4+
*eLua* stands for *Embedded Lua* and the project aims to offer the full
5+
implementation of the http://www.lua.org[Lua Programming Language] to the
6+
embedded world, extending it with specific features for efficient and portable
7+
software embedded development. For more details please visit the link:http://www.eluaproject.net[project page].
8+
9+
If you've just downloaded *eLua* and are looking to get started check out link:http://www.eluaproject.net/en_using.html[using eLua].
10+
11+
12+
General Features
13+
----------------
14+
15+
*eLua* allows you to develop and run Lua programs on a wide variety of
16+
microcontrollers.
17+
18+
Some aspects of eLua are:
19+
20+
* *Transforms hardware into a commodity:* Design and code your products for
21+
eLua and make them as hardware-independent as possible. Upgrade or
22+
completely change your hardware in the future and save time and money, using
23+
the approved source code with little or no modifications.
24+
25+
* *Source code portability:* Like in Lua, you program in C, Lua or a mixture
26+
of both and your program runs in a wide varied of (sometimes radically
27+
different) platforms and architectures supported. Full control of the
28+
platform.: eLua runs on the "bare-metal". There is no Operating System
29+
between your programs and the microcontroller. Develop on targets: fully
30+
functional Lua and a dedicated shell on the microcontroller itself. No need
31+
to install a specific development environment on the PC side, other than a
32+
serial or ehternet console/terminal emulator. You can also use any text
33+
editor, save your programs in sd/mmc and other media and use them directly
34+
in your platforms.
35+
36+
* *Flexible products:* Add modern high level script-language capabilities to
37+
your projects, resulting in highly adaptable, field-programable and
38+
reconfigurable designs. Efficient (and cheap!) future evolution to your
39+
systems.
40+
41+
* *Learn embedded:* Simple interactive and interpreted experimenting cycle.
42+
Use your desktop programming skills to become an embedded systems developer
43+
in no time and with a lot of fun.
44+
45+
* *Embedded RAD:* Prototype and experiment on a Rapid Aplication Develop
46+
model. Test your ideas directly on the target platforms and cheap
47+
development kits. No need for simulators or future code adaptations.
48+
49+
* *Ready to use kits:* A big (and growing!) number of Open Source hardware and
50+
commercially available platforms supported. Prototype cheap and fast and
51+
design your final hardware later using the produced code.
52+
53+
* *Longevity:* Add user configuration and scripting capabilities to your
54+
projects, making them adaptable to the always changing contexts of
55+
industrial processes, evolving engineering, automation standards, field
56+
optimizations etc...
57+
58+
* *Worry-free Licence:* eLua is free and open-source software and we promote
59+
it as much as we can. But our MIT licence (the same as Lua's) allows you to
60+
use eLua in your commercial and private-code products as well. Nothing to
61+
ask, no royalties to pay, just tell the world you're using eLua.
62+
63+
For more information about the functionality (implemented and planned) in eLua
64+
check link:http://www.eluaproject.net/en_status.html[our status page].
65+
66+
Contacts
67+
--------
68+
69+
eLua authors and main developers can be contacted at:
70+
71+
Bogdan Marinescu: bogdan.marinescu -at- gmail -dot- com
72+
73+
Dado Sutter: dadosutter -at- gmail -dot- com
74+
75+
James Snyder: jbsnyder -at- gmail -dot- com
76+
77+
You are also welcomed to share your questions and suggestions on our
78+
link:http://www.eluaproject.net/en_comunity.html#lists[Mail Discussion List]

README.md

-5
This file was deleted.

0 commit comments

Comments
 (0)