Skip to content

Commit

Permalink
Added basic documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Gadorek committed Aug 21, 2024
1 parent 6179002 commit f5876ce
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 17 deletions.
Binary file modified docs/__pycache__/conf_common.cpython-312.pyc
Binary file not shown.
Binary file added docs/_static/help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/en/configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Configuration
===============================
Configuration can be done in several ways. The priority order is as follows: configuration files are overridden by environment variables, which in turn can be overridden by command-line arguments. If you go through the wizard, the choices you make there will take the highest precedence.

Wizard
-------------------------
To start the wizard, simply run eim without any parameters. The wizard will guide you through the installation process. Generally, you can use the arrow keys to navigate between options, the spacebar to select options, and the Enter key to confirm your selections.

As the final step, the wizard will allow you to save your installation choices as a configuration file. This file can be shared or reused in future installations to replicate the same setup.


Command line arguments
---------------------------------
The easiest way to see all possible command-line arguments is to run eim --help, which will display the following help screen:

.. figure:: ../_static/help.png

Config File
---------------------------------
The installer can use a TOML configuration file. By default, it looks for this file at ./config/default.toml, but you can specify a different path using the `--config` command-line argument.

Here is an example of what a configuration file might look like:
.. code::
path = "/tmp/esp-new/"
idf_path = "/tmp/esp-new/v5.3/esp-idf"
tool_download_folder_name = "dist"
tool_install_folder_name = "tools"
target = ["all"]
idf_versions = ["v5.3"]
tools_json_file = "tools/tools.json"
idf_tools_path = "./tools/idf_tools.py"
mirror = "https://github.com"
idf_mirror = "https://github.com"
Env variables
---------------------------------
You can override any of the configuration settings by exporting environment variables prefixed with `ESP_`. For example, to override the `target` setting, you would use `ESP_TARGET`.
1 change: 1 addition & 0 deletions docs/en/faqs.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
FAQs
===============================
Till day of release of this documentation, no question were asked about the eim. Next version of this documentation will include answears to all the question asked before it's release.
15 changes: 10 additions & 5 deletions docs/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,25 @@ ESP-IDF Installation Manager
=============================
:link_to_translation:`zh_CN:[中文]`

The ESP-IDF Installation Manager(EIM) streamlines the setup process for working with ESP-IDF and integrated development environments (IDEs) across various platforms. This cross-platform installer simplifies the installation of prerequisites, ESP-IDF itself, and essential tools, providing a consistent and user-friendly experience on macOS, Linux, and Windows.
The ESP-IDF Installation Manager (EIM) simplifies the setup process for ESP-IDF and integrated development environments (IDEs) across multiple platforms. This cross-platform installer facilitates the installation of prerequisites, ESP-IDF itself, and essential tools, offering a consistent and user-friendly experience on macOS, Linux, and Windows.

Features
----------------

- feature 1
- feature 2

- cross-platform
- configurable
- repeatable
- easy to use
- multilangual
- easyli deployable

For more about this project please see https://github.com/espressif/idf-im-cli

.. toctree::
:maxdepth: 1

Prerequisites <prerequisites>
Installation <installation>
Configuration <configuration>
Installation of IDF <installation>
FAQs<faqs>

20 changes: 11 additions & 9 deletions docs/en/installation.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
Installation
Installation of IDF
===============================
Installing the ESP-IDF using EIM is straightforward. Simply open your preferred shell (we recommend PowerShell for Windows users) and run EIM, providing your installation preferences using any of the configuration <configuration> methods you choose. If you haven't provided all the necessary options, an interactive wizard will guide you through the remaining steps.

After Installation
===============================
Installation process goes here.

Windows
-------------------------
Windows process goes here.

On Windows, the installer creates an icon on your desktop labeled IDF_PowerShell. Clicking this icon will launch PowerShell with the environment set up, allowing you to start using ESP-IDF immediately. If you've installed multiple versions of ESP-IDF, you will have multiple icons, one for each version.

macOS
macOS & Linux
---------------------------------
macOS process goes here.
In the installation directory you selected, there will be a .sh script that, when sourced, activates the ESP-IDF environment in your current shell. It's important to note that this script should be sourced, not executed directly. If you've installed multiple versions of ESP-IDF, there will be a separate script for each version.

Linux
---------------------------------
Linux specific documentation here.
.. note::

The script should be really sourced and not executed
48 changes: 45 additions & 3 deletions docs/en/prerequisites.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
Prerequisites
===============================
The minimum requirements for running the ESP-IDF Installation Manager are below.
Below are the minimum requirements for running the ESP-IDF Installation Manager.

Windows
----------------

- git
- cmake
- ninja
- python with pip capable of creating virtual environment and doing SSL requests

.. note::

If any of these prerequisites are missing, the installer will prompt you to install them. If you agree, the installer will automatically install and configure everything required to run ESP-IDF.

MacOs
----------------

- dfu-util
- cmake
- ninja
- python with pip capable of creating virtual environment and doing SSL requests

.. note::

On POSIX systems, the installer will check for the required prerequisites. If they are not met, the installation will not proceed.

Linux
----------------

- git
- cmake
- ninja
- wget
- flex
- bison
- gperf
- ccache
- libffi-dev
- libssl-dev
- dfu-util
- libusb-1.0-0

.. note::

On POSIX systems, the installer will check for the required prerequisites. If they are not met, the installation will not proceed.

- requirements 1
- requirements 2

0 comments on commit f5876ce

Please sign in to comment.