kunthawat/ALwrity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Content Calendar, Content Gap Analysis, and Content Optimization

Browse Source
This commit is contained in:
ajaysi
2025-05-27 09:15:08 +05:30
parent 4049d19787
commit 889021c078
100 changed files with 18504 additions and 1251 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
Getting Started/README.md
View File

@@ -1,52 +1,25 @@
# ALwrity Installation Guide: Start Here!
# Getting Started with ALwrity
Welcome to ALwrity! This guide will help you choose the best installation method for your needs, whether you're a non-technical user or a developer. Please read the options below and follow the recommended path for your system.
Welcome to ALwrity! Choose the installation method that best suits you:
---
## Option 1: Quick Install for Windows Users (Recommended for Content Creators)
- No technical knowledge required
- Automatic Python installation
- One-click setup
→ [Go to Windows Quick Install](./Option_1_Windows_Quick_Install)
## Which Installation Method Should I Use?
## Option 2: Setup for Python Users
- For users who already have Python installed
- More customization options
- Manual virtual environment setup
→ [Go to Python Setup](./Option_2_Python_Users)
### 1. **Docker (Recommended for Most Users, All Platforms)**
- **Best for:** Anyone who wants a hassle-free, one-command setup on Windows, Mac, or Linux.
- **Why choose Docker?**
- No need to install Python, Rust, or system libraries manually.
- Everything runs in a safe, isolated environment.
- Consistent experience across all operating systems.
- **How to use:**
- See [README_dockerfile.md](./README_dockerfile.md) for step-by-step instructions.
## Option 3: Docker Installation
- For advanced users and developers
- Containerized environment
- Platform-independent setup
→ [Go to Docker Setup](./Option_3_Docker_Install)
### 2. **Windows One-Click Installer (`install_alwrity.bat`)**
- **Best for:** Windows users who prefer a simple double-click installer.
- **Why choose this?**
- Checks and installs all prerequisites for you (Python, Rust, Visual C++ Build Tools).
- Minimal technical knowledge required.
- **How to use:**
- See [README_install_bat.md](./README_install_bat.md) for detailed instructions.
### 3. **Manual Setup for Linux/macOS (`setup.py`)**
- **Best for:** Linux/macOS users who are comfortable with the terminal.
- **Why choose this?**
- Gives you more control over the environment.
- Useful if you want to customize or develop ALwrity.
- **How to use:**
- See [README_setup_py.md](./README_setup_py.md) for a full walkthrough.
---
## Quick Decision Table
| Your System | Easiest Method | File/Guide to Use |
|---------------------|-----------------------|--------------------------|
| Windows (any) | Docker or install_alwrity.bat | README_dockerfile.md or README_install_bat.md |
| Mac | Docker | README_dockerfile.md |
| Linux | Docker | README_dockerfile.md |
| Linux/macOS (dev) | setup.py (manual) | README_setup_py.md |
---
## Still Unsure?
- If you are not sure, **Docker is the safest and easiest choice** for most users.
- If you run into any issues, check the troubleshooting sections in each guide or [open an issue on GitHub](https://github.com/AJaySi/AI-Writer/issues).
---
Happy writing!
## Need Help?
- Visit our [GitHub Issues](https://github.com/AJaySi/AI-Writer/issues) page
- Check our [Documentation](../docs)