= IDEasy

:toc: macro

image::documentation/images/logo.png["Logo",align="center",width=60%]

Tool to automate the setup and updates of a development environment for any project (Successor of https://github.com/devonfw/ide[devonfw-ide]).

image:https://img.shields.io/github/license/devonfw/IDEasy.svg?label=License["Apache License,Version 2.0",link=https://github.com/devonfw/IDEasy/blob/master/LICENSE] image:https://img.shields.io/maven-central/v/com.devonfw.tools.IDEasy/ide-cli.svg?label=Maven%20Central["Maven Central",link=https://search.maven.org/search?q=g:com.devonfw.tools.IDEasy+a:ide-cli] image:https://coveralls.io/repos/github/devonfw/IDEasy/badge.svg?branch=main["Coverage Status",link="https://coveralls.io/github/devonfw/IDEasy?branch=main"]

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://github.com/devonfw/IDEasy/actions/workflows/integration-tests.yml/badge.svg["Integration Tests",link="https://github.com/devonfw/IDEasy/actions/workflows/integration-tests.yml"]

toc::[]

== Pitch

With IDEasy you can create a very small git repo with the configuration of the dev environment of your software project. Developers can then setup your project using IDEasy with a single CLI command on Windows, Mac, or Linux and get all the tools needed for your project in the configured version and tailored to the projects demands.

No more manual steps to install and configure, no diff-wars, no more dev setup manuals, no more "its not working on my machine"!

Among many link:documentation/alternatives.adoc[alternatives] we believe IDEasy is the best solution for project centric software development needs esp. with its link:documentation/sandbox.adoc[sandbox concept].

Not yet convinced? See link:documentation/features.adoc[features].

== Status

Currently we focused on support for Windows while official Linux and Mac support are still a little bit work in progress (see e.g. bug https://github.com/devonfw/IDEasy/issues/451[#451]). Further, we still recommend that you should contact us if you plan to use IDEasy in your project with a larger developer team. We surely try to fix bugs as soon as possible but we do not work extra shifts or prioritize your issues if you are blocked and we never promised any help before.

== Setup

=== Prerequisites

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

=== Install

The fastest way to install IDEasy is the following one-line command for bash (use git-bash on Windows):

bash -c "$(curl -fsSL https://raw.githubusercontent.com/devonfw/IDEasy/main/install.sh)"

For more details see link:documentation/setup.adoc[setup].

=== Create projects

Once installed, you can setup a new project with the following command:

ide create «project-name» [«settings-git-url»]

If you do not have a «settings-git-url», you can omit it to setup a standard Java project as demo.

==== Video Tutorial

ifdef::env-github[] image:https://img.youtube.com/vi/NG6TAmksBGI/0.jpg[link=https://www.youtube.com/watch?v=NG6TAmksBGI, width=640,height =360] endif::[]

ifndef::env-github[] video::NG6TAmksBGI[youtube] endif::[] //video::NG6TAmksBGI[youtube, width=640, height=360] // end::you[]

See also our latest video https://vimeo.com/808368450/88d4af9d18[devon ide update @ RISE]

== Documentation

link:documentation/features.adoc[Features]
link:documentation/setup.adoc[Download & Setup]
link:documentation/usage.adoc[Usage]
link:documentation/configuration.adoc[Configuration]
link:documentation/structure.adoc[Structure]
link:documentation/cli.adoc[Command Line Interface]
link:documentation/variables.adoc[Variables]
link:documentation/settings.adoc[Settings]
link:documentation/advanced-tooling.adoc[Advanced-tooling]
link:documentation/IDEasy-contribution-getting-started.adoc[Contribution]
link:documentation/[Documentation]
link:https://github.com/devonfw/IDEasy/discussions[FAQs]

== Contribution Guidelines

If you want to contribute to IDEasy please read our https://github.com/devonfw/IDEasy/blob/main/documentation/IDEasy-contribution-getting-started.adoc[Contribution Guidelines].

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

== License

link:./LICENSE[License]

IDEasy

Install / Use

README