diff --git a/docs/create_repo.png b/docs/create_repo.png new file mode 100644 index 00000000..cf92eafe Binary files /dev/null and b/docs/create_repo.png differ diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 00000000..5f1e765b --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,26 @@ +--- +marp: true +--- + +# Getting Started + +Follow the steps below to get started: + +1. Visit the [RapidRails Github](https://github.com/danielpaul/RapidRails). + +2. Click the **Use this template** button and select **Create a new repository**. + + ![Use template](use_template.png) + +3. Fill out the fields and click the **Create repository from template** button. + + ![Use template](create_repo.png) + +4. Clone the repository to your local machine. + +5. Navigate to the repository on your terminal and run `bin/setup`. + +6. Follow the prompts from the setup script to configure your application. + +7. Then simply start your server by running `bin/dev`. + And... thats it! You're all set to go! 🎉 diff --git a/docs/use_template.png b/docs/use_template.png new file mode 100644 index 00000000..fd4de564 Binary files /dev/null and b/docs/use_template.png differ