Gitnuro/README.md

69 lines
1.8 KiB
Markdown
Raw Normal View History

2021-09-24 14:25:17 +02:00
# Gitnuro
2021-11-05 04:28:12 +01:00
A FOSS Git client based on (Jetbrains) Compose and JGit.
2022-02-02 00:26:46 +01:00
The main goal of Gitnuro is to provide a multiplatform open source Git client without any kind of constraint to how you
can use it nor relying on web technologies.
2021-11-05 04:28:12 +01:00
2022-02-02 00:26:46 +01:00
The project it is still in alpha and many features are lacking or missing, but can be good for basic usage.
2021-11-05 04:28:12 +01:00
2022-01-04 20:17:21 +01:00
Right now you CAN:
- View diffs for text based files.
- View your history log and all its branches.
- Add (stage) & reset (unstage) files.
- Stage & unstage of hunks.
- Checkout files (revert changes of uncommited files).
- Clone.
- Commit.
- Reset commits.
- Revert commits.
2022-02-05 03:01:03 +01:00
- Amend previous commit.
2022-01-31 15:29:39 +01:00
- Merge.
- Rebase.
2022-01-04 20:17:21 +01:00
- Create and delete branches locally.
- Create and delete tags locally.
- View remote branches.
- Pull and push.
- Stash and pop stash.
- Checkout a commit (detached HEAD).
2022-01-31 15:29:39 +01:00
- View changes/diff in images (side to side comparison).
2022-02-01 14:44:01 +01:00
- Force push.
2022-02-04 18:54:58 +01:00
- Remove branches from remote.
2022-02-17 20:09:53 +01:00
- Manage remotes.
2022-01-04 20:17:21 +01:00
Right now you CAN'T:
- Rebase interactive.
- Remove tags from remote.
- Side by side diff in text files.
- Start a new local repository.
- View stashes in the log tree.
2022-01-17 13:07:35 +01:00
- View file history
- Blame file.
- Search by commit message/author/commit id.
2022-01-04 20:17:21 +01:00
2022-01-17 13:07:35 +01:00
## Releases
I'll create releases once we hit beta stage.
## Steps to build
Note: Requires minimum JDK 16.
- Clone the project
- Open terminal/shell in the project folder
2022-02-02 00:26:46 +01:00
- `./gradlew run` to run the project
2022-01-17 13:07:35 +01:00
- `./gradlew tasks` to view other build options (native building requires java >=15)
2021-11-05 04:28:12 +01:00
Feel free to open issues for bugs or sugestions.
2022-01-04 20:17:21 +01:00
2022-02-01 14:44:01 +01:00
## Screenshots (latest update: 01 feb 2022)
2022-02-02 00:26:46 +01:00
2022-01-04 20:17:21 +01:00
![Example 1](/res/img/gitnuro_example_1.png)
![Example 2](/res/img/gitnuro_example_2.png)
2022-01-17 13:07:35 +01:00
![Example 3](/res/img/gitnuro_example_3.png)
2022-02-01 14:44:01 +01:00
![Example 4](/res/img/gitnuro_example_4.png)
![Example 5](/res/img/gitnuro_example_5.png)
![Example 6](/res/img/gitnuro_example_6.png)