-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.html
62 lines (55 loc) · 2.63 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE html>
<html>
<head>
<title>GitSwift - Repository Management Tool</title>
<style>
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif; line-height: 1.6; max-width: 800px; margin: 0 auto; padding: 20px; color: #24292e; }
h1 { color: #0366d6; }
h2 { color: #24292e; border-bottom: 1px solid #eaecef; padding-bottom: .3em; }
code { background-color: #f6f8fa; padding: 2px 4px; border-radius: 3px; }
.highlight { background-color: #fff3cd; padding: 15px; border-radius: 4px; }
</style>
</head>
<body>
<h1>🚀 GitSwift</h1>
<h2>What is GitSwift?</h2>
<p>GitSwift is a powerful GUI tool designed to streamline Git repository management and documentation maintenance. It automates common tasks like updating changelogs, creating documentation, and managing GitHub issues.</p>
<h2>Why Was It Created?</h2>
<p>Managing repository documentation consistently can be tedious and time-consuming. GitSwift was created to solve this problem by providing a simple, intuitive interface for maintaining repository documentation and tracking changes.</p>
<h2>Key Features</h2>
<ul>
<li>Automated README updates</li>
<li>Changelog management</li>
<li>GitHub issue creation</li>
<li>Repository initialization and setup</li>
<li>Todo tracking with priority levels</li>
<li>Dark mode interface</li>
</ul>
<h2>Installation Requirements</h2>
<ul>
<li>Python 3.7+</li>
<li>Git</li>
<li>GitHub account (for GitHub integration)</li>
</ul>
<h2>Installation Steps</h2>
<ol>
<li>Clone the repository:
<br><code>git clone https://github.com/yourusername/GitSwift.git</code>
</li>
<li>Navigate to the directory:
<br><code>cd GitSwift</code>
</li>
<li>Run the requirements installer:
<br><code>python requirements.py</code>
</li>
</ol>
<h2>Usage Example</h2>
<div class="highlight">
<p><strong>Scenario:</strong> A developer needs to update multiple repository files after implementing new features.</p>
<p><strong>Traditional Approach:</strong> Manually edit README, update changelog, create issues, and document known issues - taking 15-20 minutes.</p>
<p><strong>With GitSwift:</strong> Fill in a simple form, click "Update Repository" - taking 2-3 minutes.</p>
</div>
<h2>Support</h2>
<p>For issues or feature requests, please create an issue on our GitHub repository.</p>
</body>
</html>