summaryrefslogtreecommitdiffstats
path: root/docs/git.md
diff options
context:
space:
mode:
authorHeiner Lohaus <hlohaus@users.noreply.github.com>2024-02-21 17:02:54 +0100
committerHeiner Lohaus <hlohaus@users.noreply.github.com>2024-02-21 17:02:54 +0100
commit0a0698c7f3fa117e95eaf9b017e4122d15ef4566 (patch)
tree8d2997750aef7bf9ae0f9ec63410279119fffb69 /docs/git.md
parentMerge pull request #1603 from xtekky/index (diff)
downloadgpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.tar
gpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.tar.gz
gpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.tar.bz2
gpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.tar.lz
gpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.tar.xz
gpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.tar.zst
gpt4free-0a0698c7f3fa117e95eaf9b017e4122d15ef4566.zip
Diffstat (limited to '')
-rw-r--r--docs/git.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/git.md b/docs/git.md
new file mode 100644
index 00000000..89137ffc
--- /dev/null
+++ b/docs/git.md
@@ -0,0 +1,66 @@
+### G4F - Installation Guide
+
+Follow these steps to install G4F from the source code:
+
+1. **Clone the Repository:**
+
+```bash
+git clone https://github.com/xtekky/gpt4free.git
+```
+
+2. **Navigate to the Project Directory:**
+
+```bash
+cd gpt4free
+```
+
+3. **(Optional) Create a Python Virtual Environment:**
+
+It's recommended to isolate your project dependencies. You can follow the [Python official documentation](https://docs.python.org/3/tutorial/venv.html) for virtual environments.
+
+```bash
+python3 -m venv venv
+```
+
+4. **Activate the Virtual Environment:**
+
+- On Windows:
+
+```bash
+.\venv\Scripts\activate
+```
+
+- On macOS and Linux:
+
+```bash
+source venv/bin/activate
+```
+
+5. **Install Minimum Requirements:**
+
+Install the minimum required packages:
+
+```bash
+pip install -r requirements-min.txt
+```
+
+6. **Or Install All Packages from `requirements.txt`:**
+
+If you prefer, you can install all packages listed in `requirements.txt`:
+
+```bash
+pip install -r requirements.txt
+```
+
+7. **Start Using the Repository:**
+
+You can now create Python scripts and utilize the G4F functionalities. Here's a basic example:
+
+Create a `test.py` file in the root folder and start using the repository:
+
+```python
+import g4f
+# Your code here
+```
+
+[Return to Home](/) \ No newline at end of file