Skip to content

Commit

Permalink
readme improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Gadorek committed Dec 17, 2024
1 parent 6f01f6a commit 4c46f90
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 3 deletions.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,53 @@

[![Documentation](https://img.shields.io/badge/documentation-white?style=for-the-badge&logo=readthedocs&logoColor=red)](https://docs.espressif.com/projects/idf-im-ui/en/latest/)

EIM is a cross-platform GUI application that simplifies the setup process for ESP-IDF (Espressif IoT Development Framework). Whether you’re working on macOS, Linux, or Windows, EIM offers a consistent and user-friendly experience for installing prerequisites, ESP-IDF itself, and essential development tools.
A cross-platform graphical user interface for installing and managing ESP-IDF (Espressif IoT Development Framework) and its dependencies. This tool provides a user-friendly way to set up ESP-IDF across Windows, macOS, and Linux platforms.

## Features

- 🔄 Cross-platform compatibility
- ⚙️ Configurable installation options
- 🖥️ Simple and expert installation modes
- 📦 TOML configuration support

## Installation Options

### Simplified Installation

Quick, automated installation process with default settings suitable for most users.

### Expert Installation

Step-by-step wizard with additional configuration options:

- Target chip selection
- ESP-IDF version selection
- Mirror configuration
- Custom installation paths

## Platform Support

- Windows (PowerShell shortcuts created automatically)
- macOS (Shell script for environment activation)
- Linux (Shell script for environment activation)

## Documentation

For detailed installation instructions and configuration options, please visit our [documentation](https://docs.espressif.com/projects/idf-im-ui/en/latest/).

## Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

## Issues

If you encounter any problems, please file an issue at [GitHub Issues](https://github.com/espressif/idf-im-ui/issues).

## Related Projects

- [ESP-IDF](https://github.com/espressif/esp-idf)
- [ESP-IDF Installation Manager CLI](https://github.com/espressif/idf-im-cli)

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
1 change: 0 additions & 1 deletion docs/src/before_installing.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/src/installing.md

This file was deleted.

0 comments on commit 4c46f90

Please sign in to comment.