# Writand: An Android IDE for Developers
|                  Light-mode                  |                 Dark-mode                  |
|:--------------------------------------------:|:------------------------------------------:|
| ![Writand-Lightmode](app/libs/lightmode.png) | ![Writand-Darkmode](app/libs/darkmode.png) |

## Project Overview
Writand is a new integrated development environment (IDE) designed specifically for Android devices.
Whether you're a seasoned developer or just starting, Writand offers an intuitive and powerful
platform to code on your Android tablet.

### Key features
Writand will provide an easy to use GitHub integration to easily clone repositories, manage branches,
and push your code changes directly from your tablet.

It will also have a built-in terminal for providing you with essential command-line capabilities for
efficient development.

Multi-Language support is also under progress for programming languages to reach a wide 
range of developers.

### Target Audience
Writand is designed for developers of all levels who are looking for a user-friendly IDE on Android.
Whether you're writing code, managing projects, or contributing to open-source, Writand offers the
tools you need to work efficiently on the go.

### Future
We are committed to improve Writand as a hobby project. Upcoming updates will include enhanced
language support, more advanced features, and optimizations to ensure the best possible programming
experience on Android.

## Getting Started

### Prerequisites
The minimal APK for Writand is 26, or known as Android 8.0. This is specifically designed for
tablets, so using the app on a phone might not be a good user experience. We are not aiming to
support phones for now.

### Installation
Installing our app will be possible by downloading the APK file from this GitLab repository.

## Contributing
Contributing to Writand is welcome! To contribute, please follow the guidelines below.

### Guidelines:
Contributions should follow the following guidelines:

* Follow the Kotlin KDoc for docstrings, see [this link](https://kotlinlang.org/docs/kdoc.html).
* Use branches with the format `<backend|frontend>/<name-feature>`.
* Interfaces should start with "I" followed by the name of the class/feature.
* General adapted composables should be named with "W" followed by the name of the composable. For example, the Text composable is named WText.

### Issues and Pull Requests:
If you find any issues or have suggestions for improvement, please open an issue or pull request.

To make it easier to contribute, please provide a clear description of the issue or pull request, and include any relevant code snippets or screenshots.
You should also use labels to categorize the issue or pull request.

## Additional
### Roadmap
Writand is a hobby project, but we are committed to adding essential features to make it a great IDE for Android. The roadmap includes:

- Adding a terminal for command-line access
- Integrating Git for version control management
- Multi language support

### Contact
For additional questions or features, we can be contacted through here via issues or pull requests.