Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting how to build the IDE #3387

Merged
merged 4 commits into from
Apr 12, 2022
Merged

Documenting how to build the IDE #3387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c0f82c
Check the skipValidationIndex
JaroslavTulach Apr 8, 2022
31e771a
Mention rustup, wasm-pack and cargo-watch installation command
JaroslavTulach Apr 8, 2022
5841265
Mention --no-log-masking
JaroslavTulach Apr 12, 2022
b47bedb
Merge branch 'develop' into jtulach/BuildingTheIDE
mwu-tow Apr 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,18 @@ defined by [rust-toolchain](../rust-toolchain.toml) override file. The `rustup`
will automatically download the appropriate compiler version along with the
necessary components.

Please consult the [GUI Contribution Guide](../app/gui/docs/CONTRIBUTING.md) to
learn details on setting your system up. Quick summary:

```bash
JaroslavTulach marked this conversation as resolved.
Show resolved Hide resolved
enso$ rustup toolchain install stable # Stable toolchain required for the following tools.
enso$ cargo +stable install wasm-pack --version 0.10.2 # Install the wasm-pack toolkit.
enso$ cargo +stable install cargo-watch # To enable ./run watch utility
```

The previous three steps shall be enough to build the IDE via
`./run build --dev`.

### Getting Set Up (JVM)

In order to properly build the `runtime` component, the JVM running SBT needs to
Expand Down Expand Up @@ -649,7 +661,7 @@ directory of the distribution folder. Distribution paths are printed when you
run project manager with `-v` verbose logging.

```bash
$ ./built-distribution/enso-project-manager-0.2.32-SNAPSHOT-linux-amd64/enso/bin/project-manager -v
$ ./built-distribution/enso-project-manager-0.0.0-dev-linux-amd64/enso/bin/project-manager --no-log-masking -v
[info] [2021-06-16T11:49:33.639Z] [org.enso.projectmanager.boot.ProjectManager$] Starting Project Manager...
[debug] [2021-06-16T11:49:33.639Z] [org.enso.runtimeversionmanager.distribution.DistributionManager] Detected paths: DistributionPaths(
dataRoot = /home/dbv/.local/share/enso,
Expand Down
2 changes: 1 addition & 1 deletion run
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ let args = process.argv.slice(2)
let skip_validation = '--skip-version-validation'
async function init () {
let skipValidationIndex = args.indexOf(skip_validation)
if (skip_validation === -1) {
if (skipValidationIndex === -1) {
JaroslavTulach marked this conversation as resolved.
Show resolved Hide resolved
cmd.section('Version Validation')
console.log("Use the `" + skip_validation + "` flag to skip it.")
console.log("Querying npm for the latest LTS versions.")
Expand Down