Skip to content

Commit

Permalink
Merge branch 'main' into feature/31-Implement-ToolCommandlet-for-Node…
Browse files Browse the repository at this point in the history
…-Package-Manager
  • Loading branch information
hohwille authored Mar 14, 2024
2 parents e9a05c9 + ec78a89 commit 4dba7e8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/nightly-build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Nightly CI Build and Snapshot Release
name: Nightly Build
on:
workflow_dispatch:
schedule:
Expand Down
27 changes: 9 additions & 18 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,43 +10,34 @@ image:https://img.shields.io/github/license/devonfw/IDEasy.svg?label=License["Ap
image:https://img.shields.io/maven-central/v/com.devonfw.tools.ide/ide-cli.svg?label=Maven%20Central["Maven Central",link=https://search.maven.org/search?q=g:com.devonfw.tools.ide]
image:https://github.com/devonfw/IDEasy/actions/workflows/build.yml/badge.svg["Build Status",link="https://github.com/devonfw/IDEasy/actions/workflows/build.yml"]
image:https://github.com/devonfw/IDEasy/actions/workflows/update-urls.yml/badge.svg["Update URLS Status",link="https://github.com/devonfw/IDEasy/actions/workflows/update-urls.yml"]
image:https://github.com/devonfw/IDEasy/actions/workflows/nightly-build.yml/badge.svg["Nightly Release", link="https://github.com/devonfw/IDEasy/actions/workflows/nightly-build.yml"]
image:https://coveralls.io/repos/github/devonfw/IDEasy/badge.svg?branch=main["Coverage Status",link="https://coveralls.io/github/devonfw/IDEasy?branch=main"]

toc::[]

== Setup

=== Prerequisites
** Windows
All you need before installing IDEasy is https://git-scm.com/download/[git].

** Windows
*** On Windows you need to *download and install* https://git-scm.com/download/win[git for windows].

*** You need a tool to extract `*.tar.gz` files (`tar` and `gzip`).
+
For example https://www.7-zip.org/[7-zip] or https://www.win-rar.com/[WinRar].
** Linux
*** On Linux you need to install `curl` and `git` if you don't have them already
+
[source,terminal, .text-center]
----
sudo apt-get install git curl
or
sudo yum install git-core curl
----

*** On Linux you only need to install https://git-scm.com/download/linux[git for linux].
** MacOS
*** On MacOS you only need to download and install https://git-scm.com/download/mac[git for mac].

=== Install

** Download the latest version of `devonfw-ide` from https://github.com/devonfw/IDEasy/releases[here] and extract it to a folder of your choice.
** Download the latest version of `IDEasy` from https://github.com/devonfw/IDEasy/releases[here] and execute it.
+
(You can find all Releases in https://repo.maven.apache.org/maven2/com/devonfw/tools/IDEasy/ide-cli/[Maven Central])
** Run the `setup` in this folder (On Windows you can double click on `setup.bat`)
+
A command prompt will open and the setup will start. The setup will ask for a settings URL. In case you do not have a settings URL for your project, you can just press enter to use the default settings.
A command prompt will open and the setup will start. The setup will ask for a settings URL.
In case you do not have a settings URL for your project, you can just press enter to use the default settings.
** After the setup is finished, you can close the command prompt and open a new one.
** *You are done! You can now use the `devon` command in your terminal to use the devonfw-ide.*
** *You are done! You can now use the `ide` command in your terminal to use the `IDEasy`.*

==== Video Tutorial
ifdef::env-github[]
Expand Down Expand Up @@ -79,7 +70,7 @@ See also our latest video https://vimeo.com/808368450/88d4af9d18[devon ide updat
* link:documentation/[Documentation]

== Contribution Guidelines
*If you want to contribute to `devon-ide` please read our https://github.com/devonfw/ide/blob/master/documentation/devonfw-ide-contribution-getting-started.asciidoc[Contribution Guidelines].*
*If you want to contribute to `IDEasy` please read our https://github.com/devonfw/IDEasy/blob/main/documentation/IDEasy-contribution-getting-started.asciidoc[Contribution Guidelines].*

*We use https://github.com/devonfw/IDEasy/issues[GitHub Issues] to track bugs and submit feature requests.*

Expand Down

0 comments on commit 4dba7e8

Please sign in to comment.