Browse Source

Switch to markdown

Piotr Orzechowski 1 year ago
parent
commit
4fc73d1bd1
8 changed files with 67 additions and 152 deletions
  1. 48
    28
      README.md
  2. 19
    0
      doc/changelog.md
  3. 0
    0
      doc/screenshots/fail.png
  4. 0
    0
      doc/screenshots/new.png
  5. 0
    0
      doc/screenshots/running.png
  6. 0
    0
      doc/screenshots/success.png
  7. 0
    21
      www/changes.wiki
  8. 0
    103
      www/index.wiki

+ 48
- 28
README.md View File

@@ -1,39 +1,62 @@
1
-GSummer - Simple checksum validator
2
-===================================
1
+# GSummer - Simple checksum validator
3 2
 
4
-Requirements
5
-============
3
+[What is GSummer](#what-is-gsummer) | [Features](#features) | [Screenshots](#screenshots) |
4
+[Install](#install) | [License](LICENSE) | [Changelog](doc/changelog.md)
6 5
 
7
-  1.  Build
6
+## What is GSummer?
8 7
 
9
-    *  Make
10
-    *  gettext
8
+GSummer is a simple graphical application used to validate file checksums.<br>
9
+Just run GSummer, choose file to validate, select hash algorithm, paste checksum provided by the
10
+file creator and hit "Validate".<br>
11
+Once the validation is finished, you will know whether file is ok or damaged.
11 12
 
12
-  2.  Run
13
+## Features
13 14
 
14
-    *  Python 3
15
-    *  PyGObject 3.4+ (for Python 3)
16
-    *  gettext
15
+ * Support for md5, sha1, sha224, sha256, sha384 and sha512 hash algorithms
16
+ * Cross-platform - should be able to run anywhere Python 3, PyGObject 3.4+ and gettext
17
+   are available
18
+ * Multilingual (currently Czech, English and Polish languages are available)
19
+ * Easy to use - has simple graphical interface
17 20
 
18
-Installation
19
-============
21
+## Screenshots
20 22
 
21
-Basically there's no need to install GSummer (although lack of installation script makes its version
22
-0.9.4 rather than 1.0) and thus the installation procedure is as follows:
23
+![new.png](doc/screenshots/new.png)<br>
24
+_GSummer is started or "File->New" was chosen from menu_
25
+
26
+![running.png](doc/screenshots/running.png)<br>
27
+_GSummer is calculating checksum_
28
+
29
+![success.png](doc/screenshots/success.png)<br>
30
+_Calculated checksum matched the pasted one_
31
+
32
+![fail.png](doc/screenshots/fail.png)<br>
33
+_Calculated checksum did not match the pasted one_
34
+
35
+## Install
23 36
 
24
-  1.  Download sources:
37
+#### Requirements
25 38
 
26
-    *  either log in as anonymous user, download compressed archive of chosen check-in and extract
27
-       it to destination directory
28
-    *  or clone repository using `fossil clone` command.
39
+1. Build
40
+ * Make
41
+ * gettext
29 42
 
30
-  2.  Go to project directory.
31
-  3.  Run `make build`.
32
-  4.  Rename `dist` directory to your liking and copy it wherever you like.
33
-  5.  You're done!
43
+2. Run
44
+ * Python 3
45
+ * PyGObject 3.4+ (for Python 3)
46
+ * gettext
34 47
 
35
-Usage
36
-=====
48
+#### Installation
49
+
50
+Basically there's no need to install GSummer (although lack of installation script makes its version
51
+0.9.4 rather than 1.0) and thus the installation procedure is as follows:
52
+
53
+1. Download sources from `releases` tab.
54
+2. Go to project directory.
55
+3. Run `make build`.
56
+4. Rename `dist` directory to your liking and copy it wherever you like.
57
+5. You're done!
58
+
59
+#### Usage
37 60
 
38 61
 You can start the application by issuing the command `application_directory/gsummer` on the command
39 62
 line.
@@ -42,6 +65,3 @@ To preload GSummer with file to check, you have to pass it the file name paramet
42 65
 line, eg. `gsummer -f file_to_check`.
43 66
 
44 67
 You can also create `.desktop` file to run the application with your desktop environment.
45
-
46
-[License](LICENSE)
47
-==================

+ 19
- 0
doc/changelog.md View File

@@ -0,0 +1,19 @@
1
+### Version 0.9.4 (2017-04-09 CEST)
2
+ * Select SHA-256 by default
3
+
4
+### Version 0.9.3 (2017-04-09 CEST)
5
+ * Add '-f' '--file' command line parameter
6
+ * Load appropriate gettext implementations on Linux, OSX and Windows
7
+ * Fix translations not loaded bug
8
+ * Add Makefile
9
+
10
+### Version 0.9.2 (2015-09-05 CEST)
11
+ * Add file command line parameter handling
12
+ * Reset status bar on verification start
13
+ * Update copyright notice and license info
14
+
15
+### Version 0.9.1 (2013-07-27 CEST)
16
+ * Add Czech translation; thanks to Pavel Fric \[[fripohled.blogspot.cz](http://fripohled.blogspot.cz)\]
17
+ * Add accelerators to main menu items
18
+ * Add icons to verify/cancel button
19
+ * Fix minor bugs

www/img/screenshots/fail.png → doc/screenshots/fail.png View File


www/img/screenshots/new.png → doc/screenshots/new.png View File


www/img/screenshots/running.png → doc/screenshots/running.png View File


www/img/screenshots/success.png → doc/screenshots/success.png View File


+ 0
- 21
www/changes.wiki View File

@@ -1,21 +0,0 @@
1
-<title>Change Log</title>
2
-
3
-<h2>Changes for Version 0.9.4 (2017-04-09 CEST)</h2>
4
-  *  Select SHA-256 by default
5
-
6
-<h2>Changes for Version 0.9.3 (2017-04-09 CEST)</h2>
7
-  *  Add '-f' '--file' command line parameter
8
-  *  Load appropriate gettext implementations on Linux, OSX and Windows
9
-  *  Fix translations not loaded bug
10
-  *  Add Makefile
11
-
12
-<h2>Changes for Version 0.9.2 (2015-09-05 CEST)</h2>
13
-  *  Add file command line parameter handling
14
-  *  Reset status bar on verification start
15
-  *  Update copyright notice and license info
16
-
17
-<h2>Changes for Version 0.9.1 (2013-07-27 CEST)</h2>
18
-  *  Add Czech translation; thanks to Pavel Fric &#91;[http://fripohled.blogspot.cz | fripohled.blogspot.cz]&#93;
19
-  *  Add accelerators to main menu items
20
-  *  Add icons to verify/cancel button
21
-  *  Fix minor bugs

+ 0
- 103
www/index.wiki View File

@@ -1,103 +0,0 @@
1
-<title>Home</title>
2
-
3
-<center><p><small><i>Simple checksum validator</i></small></p></center>
4
-
5
-<table align="right">
6
-<tr><td>
7
-<ul><br>
8
-<li> [#what-is-gsummer | What is GSummer]
9
-<li> [#features | Features]
10
-<li> [#screenshots | Screenshots]
11
-<li> [#install | Install]
12
-<li> [#license | License]
13
-<li> [./changes.wiki | Change Log]
14
-</ul>
15
-</td></tr>
16
-</table>
17
-
18
-<a name="what-is-gsummer"><h1>What is GSummer?</h1></a>
19
-
20
-GSummer is a simple graphical application used to validate file checksums.<br>
21
-Just run GSummer, choose file to validate, select hash algorithm, paste checksum provided by the
22
-file creator and hit "Validate".<br>
23
-Once the validation is finished, you will know whether file is ok or damaged.
24
-
25
-<a name="features"><h1>Features</h1></a>
26
-
27
-  *  Support for md5, sha1, sha224, sha256, sha384 and sha512 hash algorithms
28
-  *  Cross-platform - should be able to run anywhere Python 3, PyGObject 3.4+ and gettext
29
-     are available
30
-  *  Multilingual (currently Czech, English and Polish languages are available)
31
-  *  Easy to use - has simple graphical interface
32
-
33
-<a name="screenshots"><h1>Screenshots</h1></a>
34
-
35
-<br><center><img src="/doc/trunk/www/img/screenshots/new.png">
36
-<p><i>GSummer is started or "File->New" was chosen from menu</i></p><br><br>
37
-
38
-<img src="/doc/trunk/www/img/screenshots/running.png">
39
-<p><i>GSummer is calculating checksum</i></p><br><br>
40
-
41
-<img src="/doc/trunk/www/img/screenshots/success.png">
42
-<p><i>Calculated checksum matched the pasted one</i></p><br><br>
43
-
44
-<img src="/doc/trunk/www/img/screenshots/fail.png">
45
-<p><i>Calculated checksum did not match the pasted one</i></p></center>
46
-
47
-<a name="install"><h1>Install</h1></a>
48
-
49
-<h3>Requirements</h3>
50
-
51
-1. Build
52
-  *  Make
53
-  *  gettext
54
-
55
-2. Run
56
-  *  Python 3
57
-  *  PyGObject 3.4+ (for Python 3)
58
-  *  gettext
59
-
60
-<h3>Installation</h3>
61
-
62
-Basically there's no need to install GSummer (although lack of installation script makes its version
63
-0.9.4 rather than 1.0) and thus the installation procedure is as follows:
64
-
65
-1. Download sources:
66
-  *  either log in as anonymous user, download compressed archive of chosen check-in and extract
67
-     it to destination directory
68
-  *  or clone repository using `fossil clone` command.
69
-  
70
-2. Go to project directory.
71
-
72
-3. Run `make build`.
73
-
74
-4. Rename `dist` directory to your liking and copy it wherever you like.
75
-
76
-5. You're done!
77
-
78
-<h3>Usage</h3>
79
-
80
-You can start the application by issuing the command `application_directory/gsummer` on the command
81
-line.
82
-
83
-To preload GSummer with file to check, you have to pass it the file name parameter on the command
84
-line, eg. `gsummer -f file_to_check`.
85
-
86
-You can also create `.desktop` file to run the application with your desktop environment.
87
-
88
-<a name="license"><h1>License</h1></a>
89
-
90
-<center>Copyright &copy;2013-2017 Piotr Orzechowski &#91;orzechowski.tech&#93;.<br><br>
91
-
92
-GSummer is free software; you can redistribute it and/or modify<br>
93
-it under the terms of the GNU General Public License as published by<br>
94
-the Free Software Foundation; version 3 of the License.<br>
95
-
96
-GSummer is distributed in the hope that it will be useful,<br>
97
-but WITHOUT ANY WARRANTY; without even the implied warranty of<br>
98
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br>
99
-GNU General Public License for more details.<br>
100
-
101
-You should have received a copy of the GNU General Public License<br>
102
-along with GSummer; if not, write to the Free Software<br>
103
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110–1301 USA</center>

Loading…
Cancel
Save