enso/README.md

226 lines
9.7 KiB
Markdown
Raw Normal View History

<p align="center">
2020-03-06 13:09:54 +03:00
<br/>
2020-06-19 15:51:20 +03:00
<a href="http://enso.org">
2020-04-06 14:32:10 +03:00
<img
2020-04-21 23:00:27 +03:00
src="https://user-images.githubusercontent.com/1623053/79905826-22bac080-8417-11ea-82b0-ee015904a485.png"
2021-01-26 20:22:10 +03:00
alt="Enso Visual Environmment"
2020-04-21 23:00:27 +03:00
width="136"
2020-03-06 13:09:54 +03:00
/>
</a>
<br/>
<br/>
2020-06-19 15:51:20 +03:00
<a href="http://enso.org">
2020-04-06 14:32:10 +03:00
<img
src="https://user-images.githubusercontent.com/1623053/75661125-05664300-5c6d-11ea-9bd3-8a5355db9609.png"
alt="Enso Language"
2020-03-06 13:09:54 +03:00
width="240"
/>
</a>
<br/>
<br/>
<br/>
</p>
2020-03-06 13:09:54 +03:00
2021-02-01 14:01:07 +03:00
<p align="center">
2021-01-29 15:56:02 +03:00
<a href="https://discord.gg/PMtNMP46">
<img src="https://img.shields.io/discord/401396655599124480.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2"
2021-01-26 20:22:10 +03:00
alt="Chat">
</a>
2020-06-23 20:22:31 +03:00
<a href="https://github.com/enso-org/enso/actions">
<img src="https://github.com/enso-org/enso/workflows/Engine%20CI/badge.svg"
2020-04-06 14:32:10 +03:00
alt="Actions Status">
</a>
2021-01-28 06:45:03 +03:00
<a href="https://github.com/enso-org/ide/actions">
<img src="https://github.com/enso-org/ide/workflows/GUI%20CI/badge.svg"
alt="Actions Status">
</a>
2020-06-23 20:22:31 +03:00
<a href="https://github.com/enso-org/enso/blob/main/LICENSE">
2020-04-06 14:32:10 +03:00
<img src="https://img.shields.io/static/v1?label=Compiler%20License&message=Apache%20v2&color=2ec352&labelColor=2c3239"
alt="License">
</a>
2020-06-23 20:22:31 +03:00
<a href="https://github.com/enso-org/ide/blob/main/LICENSE">
2020-04-06 14:32:10 +03:00
<img src="https://img.shields.io/static/v1?label=GUI%20License&message=AGPL%20v3&color=2ec352&labelColor=2c3239"
alt="License">
</a>
</p>
2021-02-01 14:01:07 +03:00
<br/>
### All your data and analytics. Unified. Interactive.
2021-01-26 20:22:10 +03:00
Enso is a general-purpose programming language and environment for interactive
data processing. It is a tool that spans the entire stack, going from high-level
visualisation and communication to the nitty-gritty of backend services, all in
a single language.
2021-02-01 14:01:07 +03:00
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/content/link/materialiconsround/24px.svg">
<ul><ul>
<b>Connect to all the tools you're already using</b><br/>
Enso ships with a robust set of libraries, allowing you to work with local
files, databases, HTTP services and other applications in a seamless fashion.
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/editor/bubble_chart/materialiconsround/24px.svg">
<ul><ul>
<b>Cutting-edge visualization engine</b><br/>
Enso is equipped with a highly-tailored WebGL visualization engine capable of
displaying even millions of data points 60 frames per second in a web
browser.
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/action/translate/materialiconsround/24px.svg">
<ul><ul>
<b>Polyglot</b><br/>
Enso allows you to use any Java library in your code. Soon, it will also allow
you to copy-paste code from Python, JavaScript, Ruby, and R with close-to-zero
performance overhead at runtime.
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/av/speed/materialiconsround/24px.svg">
<ul><ul>
<b>High performance</b><br/>
Enso graphs and code can run up to 100x faster than the analoguous Python
code.
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/hardware/security/materialiconsround/24px.svg">
<ul><ul>
<b>Results you can trust</b><br/>
Enso incorporates many recent innovations in data processing and programming
language design to allow you to work quickly and trust the results that you
get. It is a purely functional programming language with higher-order
functions, user-defined algebraic datatypes, pattern-matching, and a rich set
of primitive types.
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/device/devices/materialiconsround/24px.svg">
<ul><ul>
<b>Runs everywhere</b><br/>
Enso is available on MacOS, Windows, and Linux, and the Enso IDE runs on
web-native technologies. In time, you'll be able to run it in the web-browser,
giving even your tablet of phone access to your data.
</ul></ul>
2021-01-26 20:22:10 +03:00
<br/>
2020-04-21 23:00:27 +03:00
2020-04-06 14:32:10 +03:00
### Getting Started
2020-07-21 15:59:40 +03:00
<img align="right" alt="An example Enso graph" src="https://user-images.githubusercontent.com/1623053/105841783-7c1ed400-5fd5-11eb-8493-7c6a629a84b7.png" width="380">
2021-02-01 14:01:07 +03:00
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/action/get_app/materialiconsround/24px.svg">
<ul><ul>
<b>Download Enso</b><br/>
<ul>
<li><a href="https://github.com/enso-org/ide/releases">Enso Interactive Environment</a></li>
<li><a href="https://github.com/enso-org/enso/releases">Enso Compiler (CLI, optional)</a></li>
</ul>
2021-02-01 14:01:07 +03:00
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/social/school/materialiconsround/24px.svg">
<ul><ul>
<b>Watch Tutorials</b><br/>
<ul>
<li><a href="https://www.youtube.com/watch?v=AwtAklcLrkU&ab_channel=Enso">Enso 101</a></li>
<li><a href="https://www.youtube.com/watch?v=XReCQMZUmuE&ab_channel=Enso">Trams Visualization</a></li>
<li><a href="https://www.youtube.com/playlist?list=PLk8NuufOVK01GhaObYr1_gqeASlkj2um0">... other tutorials</a></li>
</ul>
2021-02-01 14:01:07 +03:00
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/hardware/cast_for_education/materialiconsround/24px.svg">
<ul><ul>
<b>Watch Video Podcasts</b><br/>
<ul>
<li><a href="https://www.youtube.com/watch?v=U3pb7HiZIBg&t=2996s&ab_channel=Enso">Enso Textual Language Basics</a></li>
<li><a href="https://www.youtube.com/c/Enso_org/videos?view=2&sort=dd&live_view=503&shelf_id=3">... other video podcasts</a></li>
</ul>
2021-02-01 14:01:07 +03:00
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/communication/forum/materialiconsround/24px.svg">
<ul><ul>
<b>Join The Community</b><br/>
<ul>
<li><a href="https://discord.gg/enso">Discord chat. Get help, share your use cases, meet the team behind Enso and other Enso users!</a></li>
<li><a href="https://github.com/enso-org/enso/discussions">GitHub Discussion Forum</a></li>
</ul>
2021-02-01 14:01:07 +03:00
</ul></ul>
<img align="left" width="36px" src="https://github.com/google/material-design-icons/blob/master/src/av/new_releases/materialiconsround/24px.svg">
<ul><ul>
<b>Keep up with the latest updates</b><br/>
<ul>
<li><a href="https://medium.com/@enso_org">Enso Development Blog</a></li>
<li><a href="http://eepurl.com/bRru9j">Enso Mailing List</a></li>
</ul>
2021-02-01 14:01:07 +03:00
</ul></ul>
<br/><br/>
2020-04-21 23:00:27 +03:00
2021-01-26 20:22:10 +03:00
### Project components
2020-07-21 15:59:40 +03:00
2021-01-26 20:22:10 +03:00
Enso consists of several sub projects:
2020-04-21 23:00:27 +03:00
2021-02-01 14:01:07 +03:00
- **Enso Engine.** The Enso Engine is the set of tools that implement the Enso
2021-01-26 20:22:10 +03:00
language and its associated services. These include a just-in-time compiler,
2021-02-01 14:01:07 +03:00
runtime, and language server. These components can be used on their own as
command line tools.
2021-01-26 20:22:10 +03:00
- **Enso IDE**. The [Enso IDE](https://github.com/enso-org/ide) is the desktop
application that allows working with the visual form Enso. It consists of an
Electron application, a high performance WebGL UI framework, and the Searcher
which provides contextual search, hints, and documentation for Enso
functionality.
2021-01-26 20:22:10 +03:00
<br/>
### License
2020-07-21 15:59:40 +03:00
2021-02-01 14:01:07 +03:00
The Enso Engine is licensed under the
[Apache 2.0](https://opensource.org/licenses/apache-2.0), as specified in the
[LICENSE](https://github.com/enso-org/enso/blob/main/LICENSE) file. The Enso IDE
is licensed under the [AGPL 3.0](https://opensource.org/licenses/AGPL-3.0), as
specified in the [LICENSE](https://github.com/enso-org/ide/blob/main/LICENSE)
file.
2020-04-06 14:32:10 +03:00
This license set was choosen to both provide you with a complete freedom to use
Enso, create libraries, and release them under any license of your choice, while
also allowing us to release commercial products on top of the platform,
including Enso Cloud and Enso Enterprise server managers.
2021-01-26 20:22:10 +03:00
<br/>
### Contributing to Enso
2020-07-21 15:59:40 +03:00
2020-04-06 14:32:10 +03:00
Enso is a community-driven open source project which is and will always be open
and free to use. We are committed to a fully transparent development process and
highly appreciate every contribution. If you love the vision behind Enso and you
want to redefine the data processing world, join us and help us track down bugs,
implement new features, improve the documentation or spread the word!
If you'd like to help us make this vision a reality, please feel free to join
2021-02-01 14:01:07 +03:00
our [chat](https://discord.gg/enso), and take a look at our
[development and contribution guidelines](./docs/CONTRIBUTING.md). The latter
describes all the ways in which you can help out with the project, as well as
provides detailed instructions for building and hacking on Enso.
2020-07-21 15:59:40 +03:00
If you believe that you have found a security vulnerability in Enso, or that you
have a bug report that poses a security risk to Enso's users, please take a look
at our [security guidelines](./docs/SECURITY.md) for a course of action.
2021-01-26 20:22:10 +03:00
<br/>
### Enso's Design
If you would like to gain a better understanding of the principles on which Enso
is based, or just delve into the why's and what's of Enso's design, please take
a look in the [`docs/` folder](./docs/). It is split up into subfolders for each
component of Enso. You can view this same documentation in a rendered form at
[the developer docs website](https://dev.enso.org).
2021-02-01 14:01:07 +03:00
This folder also contains a document on Enso's
[design philosophy](./docs/enso-philosophy.md), that details the thought process
that we use when contemplating changes or additions to the language.
2021-01-26 20:22:10 +03:00
This documentation will evolve as Enso does, both to help newcomers to the
project understand the reasoning behind the code, but also to act as a record of
the decisions that have been made through Enso's evolution.