Merge pull request #1 from lucy-kevin/feature/readme

docs: add initial README for Droidcon Uganda program app

README.md

@@ -1,16 +1,121 @@
-# droidconug
+# Droidcon Uganda - App
 
-A new Flutter project.
+This is the open-source app for [Droidcon Uganda](https://www.uganda.droidcon.com/) that showcases the event program, helping attendees navigate the schedule, discover speakers, and plan their participation.
 
-## Getting Started
+## Table of Contents
+- [Introduction](#introduction)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
 
-This project is a starting point for a Flutter application.
+## Introduction
 
-A few resources to get you started if this is your first Flutter project:
+Droidcon Uganda is an annual conference focused on Android development, offering various talks, workshops, and networking opportunities for Android developers. This app provides the program of the event, allowing attendees to easily access the schedule, speaker details, session descriptions, and more.
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+The app is designed to help you navigate the event and stay up to date with the various activities happening during the conference.
+
+## Features
+
+- **Event Schedule**: Browse the conference program with sessions, dates, and times.
+- **Speakers**: Discover speakers and their topics.
+- **Session Details**: View detailed information about each session, including descriptions and speaker bios.
+- **Favorite Sessions**: Mark sessions as favorites and get notifications about them.
+- **Notifications**: Receive reminders about upcoming sessions and events.
+- **Interactive UI**: Easy-to-use, responsive, and visually appealing interface.
+
+## Installation
+
+To run the app locally on your machine, follow these steps:
+
+### Prerequisites
+
+- [Flutter](https://flutter.dev/docs/get-started/install) installed on your machine
+- [Android Studio](https://developer.android.com/studio) or any other IDE that supports Flutter
+
+### Steps
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/yourusername/droidcon-uganda-app.git
+```
+
+2. Navigate into the project directory:
+
+```bash
+cd DroidconUg
+```
+
+3. Install the dependencies:
+
+```bash
+flutter pub get
+```
+
+4. Run the app:
+
+```bash
+flutter run
+```
+
+## Usage
+
+Once the app is installed, you can open it to:
+
+- View the complete program for Droidcon Uganda
+- Search for sessions by date, speaker, or topic
+- Add sessions to your favorites
+- Set up notifications for important sessions
+
+### Example Screenshots
+
+(Include some screenshots of the app here to showcase the program, session details, etc.)
+
+## Contributing
+
+We welcome contributions to the Droidcon Uganda Program App! If you'd like to contribute, please follow these steps:
+
+1. **Fork the repository** to your GitHub account.
+2. **Clone the forked repository** to your local machine:
+
+    ```bash
+    git clone https://github.com/SiroDaves/DroidconUg.git
+    ```
+
+3. **Create a new branch** for your changes:
+
+    ```bash
+    git checkout -b your-branch-name
+    ```
+
+4. **Make your changes** to the code, and then **add the changes** to the staging area using the following command:
+
+    ```bash
+    git add file-name
+    ```
+
+    Replace `file name` with the name of the file you are staging
+
+5. **Commit your changes** with a message that describes the changes you made:
+
+    ``` bash
+    git commit -m " Add a suitable commit message"
+    ```
+
+
+6. **Push the changes** to your branch on GitHub:
+
+    ```bash
+    git push -u origin your-branch-name
+    ```
+
+   Replace `your-branch-name` with the name of the branch you created earlier.
+
+7. **Open a pull request** from your branch to the main repository.
+
+Please ensure that your code follows the [Flutter style guide](https://dart.dev/guides/language/effective-dart) and includes appropriate tests.
+
+## License
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.