Fix installation instructions: remove misleading npm references, clarify git clone requirement

Co-authored-by: AstroSteveo <34114851+AstroSteveo@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-09-20 23:02:57 +00:00
parent 6960742a29
commit 6641cd05ca
2 changed files with 60 additions and 32 deletions

View File

@ -4,32 +4,39 @@ The Awesome Copilot repository supports a configuration file system that allows
## Installation ## Installation
### Via NPM (Recommended) ### Via Git Clone (Required)
```bash
# Install globally
npm install -g awesome-copilot
# Or run without installing
npx awesome-copilot init
```
### Via Git Clone
```bash ```bash
# Clone the repository
git clone https://github.com/AstroSteveo/awesome-copilot git clone https://github.com/AstroSteveo/awesome-copilot
cd awesome-copilot cd awesome-copilot
# Install dependencies
npm install npm install
# Now you can use the CLI tool
node awesome-copilot.js help
``` ```
**Note:** The `awesome-copilot` package is not yet published to npm, so you must clone the repository to use the CLI tool.
## Quick Start ## Quick Start
### 1. Initialize Your Project ### 1. Initialize Your Project
Navigate to your project directory where you want to add awesome-copilot customizations, then run:
```bash ```bash
# Initialize with default configuration # Initialize with default configuration
awesome-copilot init node /path/to/awesome-copilot/awesome-copilot.js init
# Or initialize with a specific name # Or initialize with a specific name
awesome-copilot init my-project.config.yml node /path/to/awesome-copilot/awesome-copilot.js init my-project.config.yml
```
**Tip:** You can create an alias or add the awesome-copilot directory to your PATH for easier access:
```bash
# Add to your ~/.bashrc or ~/.zshrc
alias awesome-copilot="node /path/to/awesome-copilot/awesome-copilot.js"
``` ```
This creates: This creates:
@ -69,10 +76,10 @@ collections:
```bash ```bash
# Apply default configuration file # Apply default configuration file
awesome-copilot apply node /path/to/awesome-copilot/awesome-copilot.js apply
# Or apply specific configuration file # Or apply specific configuration file
awesome-copilot apply my-project.config.yml node /path/to/awesome-copilot/awesome-copilot.js apply my-project.config.yml
``` ```
This will copy the enabled files to your project's `.awesome-copilot` directory (or the directory specified in the config). This will copy the enabled files to your project's `.awesome-copilot` directory (or the directory specified in the config).
@ -145,7 +152,7 @@ npm run config help
## VS Code Integration ## VS Code Integration
The `awesome-copilot init` command automatically configures VS Code to detect your customizations: The `node awesome-copilot.js init` command automatically configures VS Code to detect your customizations:
- Creates `.vscode/settings.json` with proper file locations - Creates `.vscode/settings.json` with proper file locations
- Points to `.awesome-copilot/` directories instead of framework directories - Points to `.awesome-copilot/` directories instead of framework directories
@ -207,16 +214,15 @@ chatmodes:
If you were previously copying files manually or using an older version: If you were previously copying files manually or using an older version:
1. Remove manually copied files from your `.github` directory 1. Remove manually copied files from your `.github` directory
2. Install awesome-copilot: `npm install -g awesome-copilot` 2. Clone awesome-copilot repository: `git clone https://github.com/AstroSteveo/awesome-copilot`
3. Run `awesome-copilot init` to create a clean setup 3. Run `node /path/to/awesome-copilot/awesome-copilot.js init` to create a clean setup
4. Edit the config to enable the same items you were using manually 4. Edit the config to enable the same items you were using manually
5. Run `awesome-copilot apply` to get a clean, managed setup 5. Run `node /path/to/awesome-copilot/awesome-copilot.js apply` to get a clean, managed setup
The new approach uses `.awesome-copilot/` directory instead of `.github/` for better separation. The new approach uses `.awesome-copilot/` directory instead of `.github/` for better separation.
## Benefits ## Benefits
- **Clean Installation**: Install via npm/npx, no need to clone the entire repository
- **Centralized Management**: One file controls all your Copilot customizations - **Centralized Management**: One file controls all your Copilot customizations
- **VS Code Integration**: Automatic configuration, no manual setup required - **VS Code Integration**: Automatic configuration, no manual setup required
- **Clear Separation**: Framework files separated from your project files - **Clear Separation**: Framework files separated from your project files

View File

@ -52,12 +52,18 @@ There are two ways to use awesome-copilot customizations in your project:
Use our configuration system to manage all customizations in one place: Use our configuration system to manage all customizations in one place:
1. **Clone the repository** to your local machine or include it as a git submodule 1. **Clone the repository** to your local machine and install dependencies:
2. **Generate a configuration file** with all available options:
```bash ```bash
node awesome-copilot.js init git clone https://github.com/AstroSteveo/awesome-copilot
cd awesome-copilot
npm install
``` ```
3. **Edit the configuration** to enable the items you want: 2. **Navigate to your project directory** where you want to add awesome-copilot customizations
3. **Generate a configuration file** with all available options:
```bash
node /path/to/awesome-copilot/awesome-copilot.js init
```
4. **Edit the configuration** to enable the items you want:
```yaml ```yaml
collections: collections:
frontend-web-dev: true # Enable entire collection frontend-web-dev: true # Enable entire collection
@ -66,9 +72,9 @@ Use our configuration system to manage all customizations in one place:
instructions: instructions:
typescript-best-practices: true typescript-best-practices: true
``` ```
4. **Apply the configuration** to copy files to your project: 5. **Apply the configuration** to copy files to your project:
```bash ```bash
node awesome-copilot.js apply node /path/to/awesome-copilot/awesome-copilot.js apply
``` ```
See [CONFIG.md](CONFIG.md) for detailed configuration documentation. See [CONFIG.md](CONFIG.md) for detailed configuration documentation.
@ -119,26 +125,42 @@ We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.
Install awesome-copilot CLI for streamlined project setup: Install awesome-copilot CLI for streamlined project setup:
```bash ```bash
# Install globally via npm # Step 1: Clone the repository
npm install -g awesome-copilot git clone https://github.com/AstroSteveo/awesome-copilot
cd awesome-copilot
# Or run without installing # Step 2: Install dependencies
npx awesome-copilot init npm install
# Step 3: Verify installation
node awesome-copilot.js help
``` ```
**Quick Setup:** **Quick Setup:**
1. Navigate to your project directory 1. Navigate to your project directory: `cd /path/to/your/project`
2. Run `awesome-copilot init` to create configuration and VS Code setup 2. Run `node /path/to/awesome-copilot/awesome-copilot.js init` to create configuration and VS Code setup
3. Edit `awesome-copilot.config.yml` to enable desired items 3. Edit `awesome-copilot.config.yml` to enable desired items
4. Run `awesome-copilot apply` to copy files to your project 4. Run `node /path/to/awesome-copilot/awesome-copilot.js apply` to copy files to your project
5. Start using enhanced GitHub Copilot! 5. Start using enhanced GitHub Copilot!
**💡 Pro Tip:** Create an alias for easier access:
```bash
# Add to your ~/.bashrc or ~/.zshrc
alias awesome-copilot="node /path/to/awesome-copilot/awesome-copilot.js"
# Then you can simply use:
awesome-copilot init
awesome-copilot apply
```
✨ **Benefits:** ✨ **Benefits:**
- Clean project setup with automatic VS Code configuration - Clean project setup with automatic VS Code configuration
- Files organized in `.awesome-copilot/` directory - Files organized in `.awesome-copilot/` directory
- Automatic `.gitignore` management - Automatic `.gitignore` management
- Easy updates by re-running `apply` command - Easy updates by re-running `apply` command
**Note:** The package is not yet published to npm, so cloning the repository is currently required.
### 📖 Manual Installation ### 📖 Manual Installation
1. **Browse the Collections**: Check out our comprehensive lists of [prompts](README.prompts.md), [instructions](README.instructions.md), [chat modes](README.chatmodes.md), and [collections](README.collections.md). 1. **Browse the Collections**: Check out our comprehensive lists of [prompts](README.prompts.md), [instructions](README.instructions.md), [chat modes](README.chatmodes.md), and [collections](README.collections.md).