# xcompare

**Repository Path**: anzhuangguai/xcompare

## Basic Information

- **Project Name**: xcompare
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-12
- **Last Updated**: 2024-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img width="200" src="./public/assets/images/Icon(1).png" alt="The nucleus icon" /><br>
</p>

<h1 align="center">
xcompare
</h1>

<p align="center">
  <img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/mellobacon/Nucleus/.github%2Fworkflows%2Fpublish.yml?style=for-the-badge">
  <img alt="GitHub issues" src="https://img.shields.io/github/issues/mellobacon/Nucleus?style=for-the-badge">
  <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/mellobacon/Nucleus?style=for-the-badge">
  <img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/mellobacon/Nucleus?style=for-the-badge">
  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/mellobacon/Nucleus?style=for-the-badge">
  <img alt="Release Version" src="https://img.shields.io/github/v/tag/mellobacon/Nucleus?style=for-the-badge&label=Current">
  <img alt="Project License" src="https://img.shields.io/github/license/mellobacon/Nucleus?style=for-the-badge">
</p>

<h3 align="center">
  <a href="https://github.com/mellobacon/Nucleus/blob/d704ed7892344480fb6fcd3c94ef534f52cadc31/LICENSE">License</a> •
  <a href="https://github.com/mellobacon/Nucleus/releases">Download</a> •
  <a href="https://github.com/mellobacon/Nucleus/blob/master/CONTRIBUTING.md">How to Contribute</a> •
  <a href="https://github.com/mellobacon/Nucleus/blob/master/CODE_OF_CONDUCT.md">Code of Conduct</a>
</h3>

___

Please note that Nucleus is currently being rewritten. Features are being reworked. Refer to PR [#59](https://github.com/mellobacon/Nucleus/pull/59).
___

Nucleus is a text editor featuring a clean and easy to use user interface inspired by Visual Studio Code, Atom, Fleet, and others.

![nucleus_themes](https://github.com/user-attachments/assets/7d6cc992-3070-42c8-87ea-de1f642c42f1)

___

### Current Rewrite Progress

✅ = Implemented

🟡 = In Progress

⭕ = Not Yet Implemented

✅* = Implemented but limited for now

#### General Features

| Feature             | Progress |
|---------------------|----------|
| File Tree           | ✅        |
| Syntax Highlighting | ✅        |
| Logging             | 🟡        |
| Theming             | ✅       |
| Notifications       | ✅*        |
| Settings            | ✅        |
| Context Menus       | ✅        |
| Internal Terminal   | ✅        |
| Editor              | ✅        |
| Themes              | ✅        |


### Known issues

- 二进制大文件读取采用一次性读取方式，这是个灾难，需要修改。

## How to Install
Download the most recent build of Nucleus [from the Release page](https://github.com/mellobacon/Nucleus/releases).

**Note: Windows Only (for now)*

## Contributing

This is for those that want to contribute or build on their local machines. [Here's how to contribute](https://github.com/mellobacon/Nucleus/blob/master/CONTRIBUTING.md).

**This project is a WIP. Bugs and missing or incomplete features will be present**

## Demo

<p align="center">
  <img width="200" src="./demo.png" alt="The demo icon" /><br>
</p>