pykan icon indicating copy to clipboard operation
pykan copied to clipboard

[DOCS] Improve installation process

Open polkadot21 opened this issue 9 months ago • 0 comments

Hello,

While working with the pykan project, I noticed some opportunities to enhance the installation guidelines, which could benefit users, particularly those new to Python development. I would like to propose a few changes aimed at simplifying the setup process and promoting the use of best practices for managing Python environments.

Current Installation Process

The current guidelines in the README involve:

  • Cloning the repository
  • Navigating to the directory
  • Installing the package with pip

Proposed Enhancements

  1. Streamline Installation Commands: Combine the cloning and installation steps into a single command to simplify the process:
pip install git+https://github.com/KindXiaoming/pykan.git
  1. Guide on Virtual Environment Setup: Add instructions for setting up a Python virtual environment, which helps in isolating and managing dependencies:
python -m venv pykan-env
source pykan-env/bin/activate  # On Windows, use `pykan-env\Scripts\activate`
  1. Optional Conda Environment Setup: Provide guidelines for users who prefer Conda:
conda create --name pykan-env python=3.9.7
conda activate pykan-env

These changes aim to make the installation process more straightforward and robust, minimizing potential dependency conflicts and enhancing the user experience.

I am eager to hear your thoughts on these suggestions and would be happy to collaborate on refining them further.

polkadot21 avatar May 03 '24 13:05 polkadot21