README.md

Git Navigator

🧐 Features

Here're some of the project's best features :

• Syntax Highlighting
• Edit Files In Neovim

🛠️ Installation Steps

1. Clone the repo

git clone https://github.com/skiupace/Git-Nav.git

2. Make sure rust is installed

3. Build the project

cargo build --release

4. Run the project

cargo run

📸 Screenshots

👨‍💻 Usage

Main Usage

git-nav [path to the git repo]

Shortcuts

Shortcut	Description
Q	Quit the program
Enter	Opens the File Inside Neovim
Left Arrow	Open the folder
Right Arrow	Go back one step in the folders tree

💻 Built with

Language: Rust.

Dependencies used in the project :

• crossterm
• git2
• ignore
• ratatui
• syntect
• walkdir

⏳ Todo List

• add path validator.
• make the folders appear in Files Tree.
• add two tabs Repo and Help.
• add Search and Repo Status area.
• add arabic text rendering support.

🍰 Contribution Guidelines:

Pull requests are welcome. For major changes, please open an issue first to discuss what you want to change. please follow the contributing guidelines

🛡️ License

This project is licensed under the MIT License