From 707376a61d70ec87c7d75bdcc9b3ac52926bff7e Mon Sep 17 00:00:00 2001 From: Luna <105922175+ImLunaHey@users.noreply.github.com> Date: Fri, 3 Jan 2025 23:45:18 +1030 Subject: [PATCH] chore: add basic readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1f1cd86 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Akari + +![image](https://github.com/user-attachments/assets/e7c2ff26-1865-4e19-8f40-607eeeafebb4) +Source: https://bsky.app/profile/fettstorch.com/post/3leti7crg2k2b + + +## Contribution Guidelines + +We welcome contributions! Before submitting a pull request, please open an issue to discuss your proposed changes. This helps us track changes even if PRs are closed or abandoned. + +- Translations: When adding a new language, please specify the region (e.g., French vs. Canadian French). If starting with a general version, that's fine—just ensure to rename appropriately if regional variants are added later. +- PR Previews: We offer PR previews deployed to Cloudflare, allowing contributors to push updates and review changes. + +## Development Environment Setup + +To set up Akari for development: + +1. Fork the Repository: Start by forking the repository to your own GitHub account. +2. Clone Your Fork: `git clone https://github.com/your-username/akari` +3. Install Dependencies: Run `npm ci` to install dependencies without updating package versions. +4. Run the Development Server: Use `npm run dev` to start the development server. + +## License + +Akari is licensed under the CC0-1.0 license, meaning contributions are essentially public domain.