Skip to content

Commit eb83a63

Browse files
author
BenSt099
committed
REL(🎆): release of FC v6.2
1 parent d6fe60c commit eb83a63

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center" style="margin-bottom: 70px">
22
<h1>🔥FireCommit</h1><br>
33
<img alt="Static Badge" src="https://img.shields.io/badge/license-GNU%20Public%20v3-critical">
4-
<img alt="Static Badge" src="https://img.shields.io/badge/version-v6.1%20--%20stable-green">
4+
<img alt="Static Badge" src="https://img.shields.io/badge/version-v6.2%20--%20stable-green">
55
<img alt="Static Badge" src="https://img.shields.io/badge/lang-87b5e0?style=flat&logo=Python">
66
<img alt="Static Badge" src="https://img.shields.io/badge/Extension-133b61?style=flat&logo=Git">
77
<img alt="Static Badge" src="https://img.shields.io/badge/FireCommit-910806?style=flat&logo=Fireship">
@@ -26,23 +26,25 @@ developers. The provided script helps you with that.
2626

2727
## Installation
2828

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

3131
## Usage
3232

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

3638
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:
3739

3840
```bash
39-
python FireCommit_v6.py
41+
python FireCommit.py
4042
```
4143

4244
or
4345

4446
```bash
45-
python3 FireCommit_v6.py
47+
python3 FireCommit.py
4648
```
4749

4850
## Documentation

‎docs/docs.adoc‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,19 @@ When the scrip starts, you see something similar to this:
88

99
[source,shell]
1010
--
11-
🔥FireCommit - V.6.0
12-
[CHECK]: Detected git.
13-
[CHECK]: Loaded default template.
14-
[OPTION]: 0:start | 1:abort.
15-
[0|1]:
11+
🔥FireCommit - V.6.2
12+
[CHECK]: (i) Successful.
13+
[CHECK]: (i) Successful.
14+
[CHECK]: (i) Successful.
15+
[CHECK]: (i) Successful.
16+
[CWD]: ... your current working directory
17+
[OPTION]: 0:start | 1:abort
18+
[0|1]: 1
1619
--
1720

18-
Type `0` for actually starting and `1` for quitting.
21+
Type `0` for actually starting and `1` for quitting.
22+
23+
**NOTE**: The checks run to make sure that the two json-files are present and that the working directory is a git-repository.
1924

2025
=== Next
2126

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

6671
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).
6772

68-
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__).
73+
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__).
6974

7075
=== Finally Done
7176

0 commit comments

Comments
 (0)