diff --git a/README.md b/README.md index f105235..c6baf84 100644 --- a/README.md +++ b/README.md @@ -1 +1,139 @@ -# initvenv \ No newline at end of file +
+

Note

+ +
+ +--- + +

InitVenv

+ +
+ +
+ +## Table of Contents + +- [Table of Contents](#table-of-contents) +- [Features](#features) +- [Requirements](#requirements) +- [Installation](#installation) +- [Usage](#usage) + - [Method 1: Windows File Explorer (Recommended)](#method-1-windows-file-explorer-recommended) + - [Method 2: Command Line](#method-2-command-line) +- [How It Works](#how-it-works) +- [Screenshots](#screenshots) +- [Important Notes](#important-notes) +- [Contributing](#contributing) +- [License](#license) +- [Links](#links) +- [Contributors](#contributors) + +**InitVenv** is a cross-platform automation tool that streamlines Python development workflow by automatically creating Python virtual environments, installing project dependencies from `requirements.txt`, and activating the environment with a single command execution. Currently supports Windows, with Linux and macOS support planned for future releases. + +## Features + +- **One-command setup**: Create Python virtual environment, install requirements, and activate with a single command +- **Windows integration**: Works seamlessly with Windows File Explorer +- **Automatic detection**: Finds and installs requirements from `requirements.txt` automatically +- **Path flexibility**: Supports both absolute and relative paths +- **Zero configuration**: Just run and go + +## Requirements + +- Python installed and added to system PATH +- Windows operating system (currently Windows-only) + +## Installation + +1. Download the latest [release](https://github.com/Dev2Forge/Init-Venv/releases) +2. Run the installer +3. The installer will: + - Copy `InitVenv-{architecture}.exe` and `InitVenv.bat` to your chosen directory + - Add the installation directory to system PATH + +## Usage + +### Method 1: Windows File Explorer (Recommended) + +1. Navigate to your project directory using Windows File Explorer +2. Create a `requirements.txt` file with your Python dependencies +3. Press Ctrl + L to activate the address bar +4. Type `InitVenv` and press Enter +5. The program will automatically create the virtual environment and install dependencies + +### Method 2: Command Line + +```bash +InitVenv "C:\path\to\your\project" +``` + +You can use both absolute and relative paths: +```bash +InitVenv ".\my-project" +InitVenv ".." +``` + +## How It Works + +The installer creates a simple batch file that launches the main executable: + +```batch +@echo off +start "" "InitVenv-x64.exe" "%CD%" +exit +``` + +When you run `InitVenv`, it: +1. Detects the current directory +2. Creates a Python virtual environment (`.venv`) +3. Activates the virtual environment +4. Installs packages from `requirements.txt` (if present) +5. Keeps the terminal open for continued work + +## Screenshots + +| Scenario | Preview | +| :------- | :------ | +| Program startup error - missing working directory | Program startup error showing missing working directory configuration | +| Successful program initialization without requirements file | Program successfully started without requirements file installation | +| Console with virtual environment activated for user | Terminal console showing activated virtual environment for user interaction | +| Program execution with requirements file installation | Program running with automatic requirements file installation process | +| User terminal session maintained after setup | User terminal session preserved and ready for continued interaction | + +## Important Notes + +- The `requirements.txt` file must contain the dependencies **before** running InitVenv +- The program will not understand requirements once the virtual environment is created +- Currently supports Windows systems only + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +See the [Release Notes](https://github.com/Dev2Forge/Init-Venv/releases) for detailed development history and changelog. + +## License + +This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details. + +## Links + +- [Download from SourceForge](https://sourceforge.net/projects/init-venv/) +- [GitHub Releases](https://github.com/Dev2Forge/Init-Venv/releases) +- [Issues](https://github.com/Dev2Forge/Init-Venv/issues) +- [Pull Requests](https://github.com/Dev2Forge/Init-Venv/pulls) + +## Contributors + + + + + +

tutosrive

💻
+ +--- + +⭐ If you find this tool useful, please consider giving it a star! + + +![dev2forge](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/thumbanil-dev2forge1.webp) \ No newline at end of file