Skip to content

Readme style update #91

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 4 commits into from
Sep 14, 2020
Merged
Show file tree
Hide file tree
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
Binary file added media/styleFile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gitgud",
"version": "2.0.0",
"version": "2.1.0",
"description": "A CLI git tool",
"license": "MIT",
"bin": "cli.js",
Expand Down
43 changes: 42 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
## **Requirements**
- Have at least **git version 2.24.3** installed
- Have [npm](https://www.npmjs.com/get-npm) installed
- We do not recommend using [iTerm2](https://iterm2.com/) for GitGud due to rendering issues. [Hyper](https://hyper.is/) or the default terminal are good alternatives.


---

Expand All @@ -36,6 +38,7 @@ $ GitGud
- Navigate through the UI with either the 'tab' button or left/right arrow keys
- Press 'enter/return' button to select/click an option
- Throughout the app you can hit the 'esc'(escape) button to go back
- You can exit the app by running ctrl + c

---
## **Functionality**
Expand All @@ -61,11 +64,49 @@ $ GitGud
* ### **Access Full Log Tree**
- It will render the entire log tree overlaying the gitgud GUI.
- Press 'ESC' to exit out of log tree
### **FAQ**

---
## **Styling**
Gitgud allows users to customize both the look and feel of the app by editing the 'stylefile.'

To access the 'stylefile' of a globally installed GitGud, you will first need to find out where NPM is saving your globally installed files. To do so, run the following command:
```
npm root -g
```
This will return the location of your globally installed NPM packages.

On Mac you should see something like this: */usr/local/lib/node_modules*

On Windows, you may get this: *C:\Users\YOU\AppData\Roaming\npm\node_modules

Navigate to where your global packages are stored, open the gitgud folder, and then open the styleFile in an editor (the command: `nano styleFile.js` will open it in most mac/linux systems).

When you open the file it will look like this:

<img width="1000" alt="styleFile" src="media/styleFile.png">

* ### **`showLogo`:**
- By default this is set to `false`, but if you want to have the GitGud logo on top of your GUI you can change this to `true`.

* ### **`defaultColor`:**
- This is the color for the main text blocks throughout the app.

* ### **`accentColor`:**
- This is the color for the app borders as well as some text headers throughout the app.

* ### **`appResize`:**
- This enables the app to be responsive, allowing users to resize their console windows without having to restart the app. This may decrease performance for some users.

---

### **FAQs**
---
### **Contributing**
GitGud is a fully open source project and contributions are welcome!

When submitting a pull request, please clearly explain the feature you added or the bug you fixed.

First-time contributors are welcome as well! There are some issues marked with the `good first issue` tag. These might be a good place for beginners to start!


Thanks to [`Joseph Garrone`](https://github.com/JosephGarrone) for giving us the NPM package name.