From 28404fa0fa6dc283bc9e5eb42dd711c6403b6beb Mon Sep 17 00:00:00 2001
From: Rene Arumetsa <rene.arumetsa@gmail.com>
Date: Sat, 26 Jul 2025 16:17:48 +0300
Subject: [PATCH] Some kind of docs... atlest start of one :).

---
 README.md     | 56 ++++++++++++++++++++++++++++++---------------------
 docs/SETUP.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 86 insertions(+), 23 deletions(-)
 create mode 100644 docs/SETUP.md

diff --git a/README.md b/README.md
index e215bc4..cecbf10 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,46 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# 🎮 TIPILAN
 
-## Getting Started
+**TIPILAN** is the official web platform for the TipiLAN LAN event — built using [Next.js](https://nextjs.org) and powered by the lightning-fast [Bun](https://bun.sh) runtime.
 
-First, run the development server:
+> ⚠️ This is a work in progress! Contributions welcome.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+---
+
+## 🚀 Features
+
+- Event information & schedule
+- Stream
+- Responsive dark-themed UI
+- Built with Next.js, styled with Tailwind (if applicable), powered by Bun
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+---
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## 📦 Tech Stack
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+- [Next.js](https://nextjs.org/)
+- [Bun](https://bun.sh/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [React](https://reactjs.org/)
+- [Tailwind CSS](https://tailwindcss.com/) *(if used)*
 
-## Learn More
+---
 
-To learn more about Next.js, take a look at the following resources:
+## 🛠️ Setup Instructions
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+📖 See [`docs/SETUP.md`](./docs/SETUP.md) for a full setup guide on:
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+- ✅ Windows (native)
+- 🐧 Windows with WSL
+- 🐧 Linux (Ubuntu, Arch, Fedora, etc.)
 
-## Deploy on Vercel
+---
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## 🧪 Scripts
+
+```bash
+bun dev        # Run development server
+bun run build  # Build for production
+bun start      # Start production server
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+bun test       # Run tests (if configured)
+bun run lint   # Run linter (if configured)
diff --git a/docs/SETUP.md b/docs/SETUP.md
new file mode 100644
index 0000000..c785dbc
--- /dev/null
+++ b/docs/SETUP.md
@@ -0,0 +1,53 @@
+# Setup
+
+## Prerequisites
+- Git
+- Bun
+
+## Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/Lapikud/tipilan.git
+   ```
+2. Install bun:
+   ```bash
+   curl -fsSL https://bun.sh/install | bash
+   ```
+3. Install dependencies:
+   ```bash
+   cd tipilan
+   bun install
+   ```
+4. Run the application:
+   ```bash
+   bun run dev
+   ```
+5. Build the application:
+   ```bash
+   bun run build
+   ```
+## Accessing the Application
+- The application is now running at `http://localhost:3000`.
+
+## Git branch
+- The current production branch is `main`.
+- Please make sure you make changes in your branch before creating a pull request.
+### Making git branch
+- Create a new branch:
+   ```bash
+   git checkout -b <branch-name>
+   ```
+- Commit your changes:
+   ```bash
+   git add .
+   git commit -m "<commit-message>"
+   ```
+- Push your branch:
+   ```bash
+   git push origin <branch-name>
+   ```
+- Create a pull request:
+   ```bash
+   git pull-request
+   ```