enso/app/gui/README.md
Michał Wawrzyniec Urbańczyk 6fc4947764
Bumped the build script (#3489)
* The bash entry point was renamed `run.sh` -> `run`. Thanks to that `./run` works both on Linux and Windows with PowerShell (sadly not on CMD). 
* Everyone's favorite checks for WASM size and program versions are back. These can be disabled through `--wasm-size-limit=0` and `--skip-version-check` respectively. WASM size limit is stored in `build-config.yaml`.
* Improved diagnostics for case when downloaded CI run artifact archive cannot be extracted. 
* Added GH API authentication to the build script calls on CI. This should fix the macOS build failures that were occurring from time to time. (Actually they were due to runner being GitHub-hosted, not really an OS-specific issue by itself.)
* If the GH API Personal Access Token is provided, it will be validated. Later on it is difficult to say, whether fail was caused by wrong PAT or other issue.
* Renamed `clean` to `git-clean` as per suggestion to reduce risk of user accidently deleting unstaged work. 
* Whitelisting dependabot from changelog checks, so PRs created by it are mergeable.
* Fixing issue where wasm-pack-action (third party) randomly failed to recognize the latest version of wasm-pack (macOS runners), leading to failed builds.
* Build logs can be filtered using `ENSO_BUILD_LOG` environment variable. See https://docs.rs/tracing-subscriber/0.3.11/tracing_subscriber/struct.EnvFilter.html#directives for the supported syntax.
* Improve help for ci-run source, to make clear that PAT token is required and what scope is expected there.

Also, JS parts were updated with some cleanups and fixes following the changes made when introducing the build script.
2022-06-01 13:44:40 +02:00

89 lines
3.7 KiB
Markdown

# This is the subtree for Enso's graphical interface component. If you're looking for the repository root, you may find it at at 👉 <a href="https://github.com/enso-org/enso">github.com/enso-org/enso</a> 👈
<br/>
# Enso IDE
### Overview
<p>
<a href="https://discord.gg/PMtNMP46">
<img src="https://img.shields.io/discord/401396655599124480.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2"
alt="Chat">
</a>
<a href="https://github.com/enso-org/enso/blob/develop/LICENSE">
<img src="https://img.shields.io/static/v1?label=Compiler%20License&message=Apache%20v2&color=2ec352&labelColor=2c3239"
alt="License">
</a>
<a href="https://github.com/enso-org/enso/tree/develop/gui/LICENSE">
<img src="https://img.shields.io/static/v1?label=GUI%20License&message=AGPL%20v3&color=2ec352&labelColor=2c3239"
alt="License">
</a>
</p>
Enso is an award-winning interactive programming language with dual visual and
textual representations. 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. Watch the following introduction video to
learn what Enso is, and how it helps companies build data workflows in minutes
instead of weeks.
This repository contains the source code of Enso interface only. If you are
interested in how the interface is build or you want to develop it with us, you
are in the right place. See the
[development and contributing guidelines](docs/CONTRIBUTING.md) to learn more
about the code structure and the development process.
<br/>
### Getting Started
Enso is distributed both in form of
[pre-build packages for MacOS, Windows, or Linux](https://github.com/enso-org/ide/releases),
as well as the [source code](https://github.com/enso-org). See the
[demo scenes](http://TODO), and read the [documentation](docs/product) to learn
more.
<br/>
### Building
The project builds on macOS, Linux, and Windows. Build functionality is provided
by our build script, that are accessible through `run` (Linux and macOS) or
`run.cmd` (Windows) wrappers.
To build the project, simply run `./run ide build` (on Linux or macOS) or
`.\run.cmd ide build` (Windows) to build IDE. To learn more about other
available commands use `--help` argument. Read the detailed
[development guide](docs/CONTRIBUTING.md) to learn more.
<br/>
### License
The Enso Language Compiler is released under the terms of the
[Apache v2 License](https://github.com/enso-org/enso/blob/develop/LICENSE). The
Enso Graphical Interface and it's rendering engine are released under the terms
of the
[AGPL v3 License](https://github.com/enso-org/enso/blob/develop/app/gui/LICENSEE).
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 on-premise server managers.
<br/>
### Contributing
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! Join our
community on a [Discord chat](http://chat.enso.org) and read the
[development and contributing guidelines](docs/CONTRIBUTING.md).
<a href="https://github.com/enso-org/ide/graphs/contributors">
<img src="https://opencollective.com/enso-language/contributors.svg?width=890&button=false" />
</a>