From 7704dbfdf2266fb89f07fda74c46b9a7a40201c1 Mon Sep 17 00:00:00 2001 From: jan-vcapgemini <59438728+jan-vcapgemini@users.noreply.github.com> Date: Wed, 20 Nov 2024 13:24:13 +0100 Subject: [PATCH] #767: Adjusted setup documentation (#776) --- documentation/setup.adoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/documentation/setup.adoc b/documentation/setup.adoc index 0a25266a1..08fd6eb2c 100644 --- a/documentation/setup.adoc +++ b/documentation/setup.adoc @@ -26,6 +26,8 @@ Create a central folder `projects` folder (on Windows use `C:\projects` or `D:\p Inside this folder, create a sub-folder named `_ide` and extract the contents of the downloaded archive (`ide-cli-*.tar.gz`) to this new folder (e.g. `C:\projects\_ide`). Run the command `setup` in this folder (on windows double clicking on `setup.bat`). To get started read the link:usage.adoc[usage]. +After the installation process, you can create a new project by typing: `ide create `, replace `` with your project name. +Switch to the project folder e.g. `cd ` and install or configure tools for your project as needed. NOTE: We are planning to create a installer that will guide users through the installation process but this is not yet released. @@ -45,10 +47,10 @@ Instead you just create a folder and extract the xref:download[downloaded] archi All the other softwares remain locally in your IDEasy folder. However, there are the following excuses (what is reverted by `ide uninstall`): -* The `ide` command is copied to your home directory (`~/.ide/scripts/ide`) -* The `ide` alias is added to your shell config (`~/.bashrc` and `~/.zshrc`, search for `alias ide="source ~/.ide/scripts/ide"`). -* On Windows the `ide.bat` command is copied to your home directory (`%USERPROFILE%\.ide\scripts\ide.bat`) -* On Windows this `%USERPROFILE%\.ide\scripts` directory is added to the `PATH` of your user. +* The `ide` alias is added to your shell config (`~/.bashrc` and `~/.zshrc`, search for: `alias ide=`). +* The `completion` is added to your shell config (`~/.bashrc` and `~/.zshrc`, search for: `_ide/completion`). +* The `IDE_ROOT` environment variable is added to your environment variables. +* The `$IDE_ROOT/_ide/bin` folder is added to your `PATH` environment variable. * `IDEasy` will download all third party software to your `~/Downloads/ide` folder to reduce redundant storage. You have to delete this folder manually as we do not want to be responsible for data-loss in case users manually put files here.