diff --git a/README.md b/README.md index 23a9c4d..78e49e4 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,15 @@ Before installing this project, ensure you have the following requirements: ### Clone the Repository -Clone the project using the `dev` branch (this branch contains the latest development features): +Clone the project using the default `master` branch: ```bash -git clone -b dev https://github.com/your-username/coastline-extraction.git -cd coastline-extraction +git clone https://github.com/fwitmer/CoastlineExtraction.git +cd CoastlineExtraction ``` +> ⚠️ Note: The repository currently contains only the `master` branch. Earlier versions of this README referenced a non-existent `dev` branch and an incorrect repository URL (`coastlineExtraction.git`), which caused cloning to fail for new users. + --- ### Environment Setup @@ -124,20 +126,22 @@ shapefile_path = get_shapefile_path(config, 0) # First shapefile ## Contributing -### Working with the Dev Branch +### Contribution Workflow + +This project currently uses the `master` branch as the primary development branch. -This project uses the `dev` branch for active development. When contributing: +When contributing: 1. **Fork the repository on GitHub** -2. **Clone your fork using the `dev` branch**: +2. **Clone your fork**: ```bash -git clone -b dev https://github.com/your-username/coastline-extraction.git -cd coastline-extraction +git clone https://github.com/your-username/CoastlineExtraction.git +cd CoastlineExtraction ``` -3. **Create a feature branch from `dev`**: +3. **Create a feature branch from `master`**: ```bash git checkout -b feature/your-feature-name