Skip to content

Commit

Permalink
REL(🎆): release of FC v6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
BenSt099 committed Aug 30, 2023
1 parent d6fe60c commit eb83a63
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 12 deletions.
File renamed without changes.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center" style="margin-bottom: 70px">
<h1>🔥FireCommit</h1><br>
<img alt="Static Badge" src="https://img.shields.io/badge/license-GNU%20Public%20v3-critical">
<img alt="Static Badge" src="https://img.shields.io/badge/version-v6.1%20--%20stable-green">
<img alt="Static Badge" src="https://img.shields.io/badge/version-v6.2%20--%20stable-green">
<img alt="Static Badge" src="https://img.shields.io/badge/lang-87b5e0?style=flat&logo=Python">
<img alt="Static Badge" src="https://img.shields.io/badge/Extension-133b61?style=flat&logo=Git">
<img alt="Static Badge" src="https://img.shields.io/badge/FireCommit-910806?style=flat&logo=Fireship">
Expand All @@ -26,23 +26,25 @@ developers. The provided script helps you with that.

## Installation

Download the provided files ([See Latest Release](https://github.com/BenSt099/FireCommit/releases)) and unpack them. See **Usage** for starting the script.
Download the source code ([See latest releases](https://github.com/BenSt099/FireCommit/releases)) and unpack them. See **Usage** for starting the script.

## Usage

First, choose the working directory (so where your project's `.git`-folder is located) by modifiying `config.json`.
Under Windows, you have to escape the backslash (e.g. __C:\\\\User\\\\Projects\\\\YourProject\\\\__).
It's set to the directory where the script is in (`./`) by default.

**NOTE:** Under Windows, you have to escape the backslash (e.g. __C:\\\\User\\\\Projects\\\\YourProject\\\\__).

The script was tested on Windows and Linux (MacOS: Not Tested (Works on my machine 😉)). For starting the script, open a terminal / command prompt and type:

```bash
python FireCommit_v6.py
python FireCommit.py
```

or

```bash
python3 FireCommit_v6.py
python3 FireCommit.py
```

## Documentation
Expand Down
19 changes: 12 additions & 7 deletions docs/docs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,19 @@ When the scrip starts, you see something similar to this:

[source,shell]
--
🔥FireCommit - V.6.0
[CHECK]: Detected git.
[CHECK]: Loaded default template.
[OPTION]: 0:start | 1:abort.
[0|1]:
🔥FireCommit - V.6.2
[CHECK]: (i) Successful.
[CHECK]: (i) Successful.
[CHECK]: (i) Successful.
[CHECK]: (i) Successful.
[CWD]: ... your current working directory
[OPTION]: 0:start | 1:abort
[0|1]: 1
--

Type `0` for actually starting and `1` for quitting.
Type `0` for actually starting and `1` for quitting.

**NOTE**: The checks run to make sure that the two json-files are present and that the working directory is a git-repository.

=== Next

Expand Down Expand Up @@ -65,7 +70,7 @@ When you're done, the script will print out:

You can see the full message printed out (`0`), you can save it to a .txt-file (`1`), you can commit (`2`) or you can abort (`3`) (exits the script).

When you're finally done, the script will start a new round (If you are familiar with Python and you don't like this behaviour, you can change that in the main-function in _FireCommit_v6.py__).
When you're finally done, the script will start a new round (If you are familiar with Python and you don't like this behaviour, you can change that in the main-function in _FireCommit.py__).

=== Finally Done

Expand Down

0 comments on commit eb83a63

Please sign in to comment.