Add GitHub repository setup instructions to README
This commit is contained in:
parent
831b650111
commit
d8fda9fe5d
62
README.md
62
README.md
@ -118,4 +118,64 @@ If you encounter issues:
|
||||
|
||||

|
||||
|
||||
*Note: Add your own screenshot after running the application*
|
||||
*Note: Add your own screenshot after running the application*
|
||||
|
||||
## GitHub Repository Setup
|
||||
|
||||
This project is already initialized as a Git repository. To push it to a private GitHub repository:
|
||||
|
||||
### Option 1: Using GitHub CLI (Recommended)
|
||||
|
||||
1. Install GitHub CLI if not already installed:
|
||||
```bash
|
||||
# On Ubuntu/Debian
|
||||
sudo apt install gh
|
||||
|
||||
# On macOS
|
||||
brew install gh
|
||||
```
|
||||
|
||||
2. Authenticate with GitHub:
|
||||
```bash
|
||||
gh auth login
|
||||
```
|
||||
|
||||
3. Create a new private repository:
|
||||
```bash
|
||||
gh repo create quadratic-plotter --private --source=. --remote=origin --push
|
||||
```
|
||||
|
||||
### Option 2: Manual Setup
|
||||
|
||||
1. Create a new private repository on [GitHub.com](https://github.com/new):
|
||||
- Repository name: `quadratic-plotter` (or your preferred name)
|
||||
- Select "Private"
|
||||
- Do NOT initialize with README, .gitignore, or license
|
||||
|
||||
2. Add the remote and push:
|
||||
```bash
|
||||
git remote add origin https://github.com/YOUR_USERNAME/quadratic-plotter.git
|
||||
git branch -M main
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
### Option 3: Using SSH
|
||||
|
||||
If you prefer SSH authentication:
|
||||
|
||||
1. Add your SSH key to GitHub
|
||||
2. Use SSH URL:
|
||||
```bash
|
||||
git remote add origin git@github.com:YOUR_USERNAME/quadratic-plotter.git
|
||||
git branch -M main
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
### Verification
|
||||
|
||||
After pushing, verify your repository:
|
||||
```bash
|
||||
git log --oneline
|
||||
git remote -v
|
||||
git status
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user