Neocode is a lightweight, terminal-based text editor written in C that focuses on efficiency and minimal resource usage. It uses a piece table data structure for text manipulation, providing efficient editing operations even for large files. Designed with a clean, modular architecture, Neocode offers a responsive editing experience with essential features for developers and writers who prefer working in terminal environments.

• Installation
• Usage
• Features
• Technologies
• Project Structure
• Contributing
• License
• Status

- GCC or compatible C compiler
- Make build system
- POSIX-compliant operating system (Linux, macOS, etc.)

- Standard C libraries only (no external dependencies)

# Step 1: Clone the repository
git clone https://github.com/username/neocode.git

# Step 2: Navigate to the project directory
cd neocode

# Step 3: Build the project
make

# Step 4: Run the editor
./bin/ncode [filename]

The editor should build and run on most Linux distributions without modification.

Compatible with macOS. Build using the standard steps above.

Not directly supported. Consider using WSL (Windows Subsystem for Linux) for Windows compatibility.

If you encounter build errors, ensure your compiler supports C99 standards and that you have proper permissions to create files in the bin/ and obj/ directories.

# Open a file for editing
./bin/ncode myfile.txt

# Create a new file (will be saved when you exit)
./bin/ncode newfile.txt

• Arrow Keys: Move cursor
• Page Up/Down: Scroll page by page
• Home/End: Move to start/end of line
• Ctrl+Home/End: Move to start/end of document
• Ctrl+Left/Right: Move by word
• Mouse: Click to position cursor, wheel to scroll

• Ctrl+Q: Quit the editor

• Efficient text manipulation using piece table data structure
• Terminal-based user interface with minimal resource usage
• File loading and saving
• Mouse support for navigation and cursor positioning

• Line numbers for easy reference
• Status bar showing filename, modification status, and cursor position
• Scrollbar for easier navigation in long files
• Minimal memory footprint even for large files
• Responsive editing experience

• Text editing and modification
• Search and replace functionality
• Syntax highlighting for common programming languages
• Multiple file editing with tabs or buffers
• Configuration system for key bindings and preferences

• C: Core programming language
• POSIX APIs: Terminal handling and file operations
• Piece Table: Efficient text storage and manipulation
• Make: Build system

neocode/
├── bin/             # Compiled binary
├── include/         # Header files
│   ├── core/        # Core functionality
│   ├── io/          # Input/output operations
│   ├── ui/          # User interface
│   └── utils/       # Utility functions
├── obj/             # Object files
├── src/             # Source code
│   ├── core/        # Core implementation
│   ├── io/          # I/O implementation
│   ├── ui/          # UI implementation
│   ├── utils/       # Utilities implementation
│   └── main.c       # Entry point
├── .gitignore       # Git ignore file
├── Makefile         # Build configuration
└── README.md        # Project documentation

Neocode uses a modular MVC-inspired architecture:

• Model: Buffer (piece table) for text storage and manipulation
• View: Viewport and UI for displaying and rendering content
• Controller: Editor and Commands for handling user input and operations

Please submit issues through the GitHub issue tracker with a clear description of the problem, expected behavior, and steps to reproduce.

1. Fork the repository and create a feature branch
2. Make your changes with appropriate tests
3. Ensure code follows the project's coding standards
4. Submit a pull request with a clear description of changes

• Follow C99 standards
• Use consistent indentation (4 spaces)
• Include comments for non-obvious code sections
• Keep functions small and focused on a single responsibility

This project is licensed under the MIT License - see the LICENSE file for details.

• Current Version: v0.1.0
• Status: Active Development
• Last Updated: April 2025

Initial alpha release featuring file viewing capabilities, navigation, and the core architecture. Editing capabilities are planned for the next release.

Built by Rhamsez Thevenin 🌹