Skip to content

Commit

Permalink
Add "Starting a project from the Jumpstart" to README.md
Browse files Browse the repository at this point in the history
Add "Starting a project from the Jumpstart" to README.md so that people
are aware of how they should start the project from the jumpstart.

skip_ticket_id_check

<!-- ps-id: 13f73b77-3e05-4e99-b979-53a96a134093 -->
  • Loading branch information
drewdeponte committed Feb 15, 2023
1 parent 6852d71 commit 5c88f29
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@

## Starting a project from the Jumpstart

The following is the recommended approach for setting up a new project from this jumpstart as it will allow you to easily integrate updates from the jumpstart into your project in the future.

1. Clone jumpstart repo to your project folder `git clone git@github.com:uptech/flutter_lib_jumpstart.git <your-project-name>`
2. Change into your project directory `cd <your-project-name>`
3. Rename the `origin` remote to `jumpstart`, ex: `git remote rename origin jumpstart`
4. Create your repository on GitHub
5. Add your your repository as a remote named `origin`, ex: `git remote add origin <your-repository-url>`
6. Push your local repository up to the remote repository you just setup on GitHub, ex: `git push -u origin main:main`

From this point on you are good to start developing, committing, and integrating changes as you normally would. But this sets you up to easily be able to integrate improvements to jumpstart over time.

## Updating from Jumpstart

To update from the jumpstart we simply do the following.

1. Make sure you or checked out on `main`, ex: `git checkout main`
2. Make sure the local repo knows all about the remote jupmstart repo, ex: `git fetch jumpstart`
3. Merge jumpstarts changes into your `main` branch, ex: `git merge jumpstart/main`

The ease of this process will hopefully aid in you making necessary changes in jumpstart and merging them back into your project. That way we can all share in the progress together.

<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
Expand Down

0 comments on commit 5c88f29

Please sign in to comment.