diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..8bda9fece01fd60b1fbdc3067fb2b71c3c0583e7 --- /dev/null +++ b/README.md @@ -0,0 +1,101 @@ +```markdown +# Code Screenshot Generator + +A beautiful web application for generating aesthetic code screenshots with customizable backgrounds, themes, and window styles. + +![Screenshot](.github/screenshot.png) + +## Features + +- Real-time code editor with syntax highlighting +- Multiple theme options (light/dark and custom colors) +- Customizable window appearance (shadows, reflections) +- Background particle effects and textures +- Preset system for saving favorite configurations +- Export to PNG functionality +- Mobile responsive design + +## Technologies Used + +- Vue.js/Nuxt.js frontend +- Shiki for syntax highlighting +- Tailwind CSS for styling +- Vercel for hosting +- Drizzle ORM for database + +## Setup + +### Prerequisites + +- Node.js (v18+ recommended) +- pnpm + +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/your-username/code-screenshot.git + cd code-screenshot + ``` + +2. Install dependencies: + ```bash + pnpm install + ``` + +3. Create a `.env` file based on `.env.example` + +4. Run the development server: + ```bash + pnpm dev + ``` + +5. Open [http://localhost:3000](http://localhost:3000) in your browser + +## Usage + +1. Enter or paste your code in the editor +2. Customize the appearance using the sidebar controls: + - Window style (shadows, reflections) + - Color theme + - Background effects + - Social media preview settings +3. Export your creation as a PNG + +### Advanced Features + +- Create and save presets for your favorite configurations +- Import/export presets as JSON files +- Adjust detailed settings like: + - Line numbers + - Window padding + - Code font size + - Background particles intensity + +## Project Structure + +``` +app/ + components/ # UI components + lib/ # Business logic and utilities + styles/ # CSS styles +server/ + api/ # API routes + database/ # Database schema and migrations +public/ # Static assets +``` + +## Contributing + +Contributions are welcome! Please follow these guidelines: + +1. Fork the project +2. Create your feature branch +3. Commit your changes with clear messages +4. Push to the branch +5. Open a pull request + +## License + +MIT - See [LICENSE](LICENSE) for details. +``` \ No newline at end of file