devonfw / IDEasy

Tool to automate the setup and updates of a development environment for any project (Successor of devonfw-ide).
Apache License 2.0
8 stars 20 forks source link

= 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://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::[]

== 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].

== Setup

=== Prerequisites

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

=== Install

Download the latest version of IDEasy from https://github.com/devonfw/IDEasy/releases[here] and install it. (You can find all Releases in https://repo.maven.apache.org/maven2/com/devonfw/tools/IDEasy/ide-cli/[Maven Central])

=== 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

== 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