Skip to content

Update README.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ CodeAstra is a modern, extensible, and lightweight code editor built using C++ a

CodeAstra is **under active development**—stay tuned for updates or feel free to contribute and help shape its future!

## Disclaimer
This project has been tested on macOS but not yet on Windows or Linux. It should run on Linux without issues. However, on Windows, you may encounter errors. Docker will be used soon to avoid cross platform issues for development.
> [!IMPORTANT]
>
> This project has been tested on macOS, but not on Windows or Linux. It should work on Linux without issues. However, on Windows, you might encounter errors. To address cross-platform compatibility, Docker will be implemented soon for development.

## How to install the project
Please, check the [wiki](https://github.com/sandbox-science/CodeAstra/wiki) for recommended installation instructions.
Expand All @@ -30,4 +31,4 @@ Please, check the [wiki](https://github.com/sandbox-science/CodeAstra/wiki) for
- [ ] Plugin system

## To-Do
Find tasks to-do on our open [issues](https://github.com/sandbox-science/CodeAstra/issues)
Find tasks to-do on our open [issues](https://github.com/sandbox-science/CodeAstra/issues)