Browse Source

Switch to markdown

Piotr Orzechowski 9 months ago
parent
commit
8b89227cb3
8 changed files with 66 additions and 152 deletions
  1. 51
    29
      README.md
  2. 15
    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
    17
      www/changes.wiki
  8. 0
    106
      www/index.wiki

+ 51
- 29
README.md View File

@@ -1,40 +1,65 @@
1
-QSummer - Simple checksum validator
2
-===================================
1
+# QSummer - Simple checksum validator
3 2
 
4
-Requirements
5
-============
3
+[What is QSummer](#what-is-qsummer) | [Features](#features) | [Screenshots](#screenshots) |
4
+[Install](#install) | [License](LICENSE) | [Changelog](doc/changelog.md)
6 5
 
7
-  1.  Build
6
+## What is QSummer?
8 7
 
9
-    *  Make
10
-    *  Python 3
11
-    *  pyside-lupdate from pyside-tools package
12
-    *  lrelease from Qt's Linguist tool chain
8
+QSummer is a simple graphical application used to validate file checksums.<br>
9
+Just run QSummer, 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.
13 12
 
14
-  2.  Run
13
+## Features
15 14
 
16
-    *  Python 3
17
-    *  PySide 1.1.0+ (Python 3 version)
15
+ * Support for md5, sha1, sha224, sha256, sha384 and sha512 hash algorithms
16
+ * Cross-platform - should be able to run anywhere Bash, Python 3 and PySide 1.1.0+ are available 
17
+   (though icons will be shown on systems adhering to freedesktop.org
18
+   [Icon Naming Specification](http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html)
19
+   only)
20
+ * Multilingual (currently Czech, English and Polish languages are available)
21
+ * Easy to use - has simple graphical interface
18 22
 
19
-Installation
20
-============
23
+## Screenshots
21 24
 
22
-Basically there's no need to install QSummer (although lack of installation script makes its version
23
-0.9.4 rather than 1.0) and thus the installation procedure is as follows:
25
+![new.png](doc/screenshots/new.png)<br>
26
+_QSummer is started or "File->New" was chosen from menu_
27
+
28
+![running.png](doc/screenshots/running.png)<br>
29
+_QSummer is calculating checksum_
30
+
31
+![success.png](doc/screenshots/success.png)<br>
32
+_Calculated checksum matched the pasted one_
33
+
34
+![fail.png](doc/screenshots/fail.png)<br>
35
+_Calculated checksum did not match the pasted one_
36
+
37
+## Install
24 38
 
25
-  1.  Download sources:
39
+#### Requirements
26 40
 
27
-    *  either log in as anonymous user, download compressed archive of chosen check-in and extract
28
-       it to destination directory
29
-    *  or clone repository using `fossil clone` command.
41
+1. Build
42
+ * Make
43
+ * Python 3
44
+ * pyside-lupdate from pyside-tools package
45
+ * lrelease from Qt's Linguist tool chain
30 46
 
31
-  2.  Go to project directory.
32
-  3.  Run `make build`.
33
-  4.  Rename `dist` directory to your liking and copy it wherever you like.
34
-  5.  You're done!
47
+2. Run
48
+ * Python 3
49
+ * PySide 1.1.0+ (Python 3 version)
35 50
 
36
-Usage
37
-=====
51
+#### Installation
52
+
53
+Basically there's no need to install QSummer (although lack of installation script makes its version
54
+0.9.4 rather than 1.0) and thus the installation procedure is as follows:
55
+
56
+1. Download sources from `releases` tab.
57
+2. Go to project directory.
58
+3. Run `make build`.
59
+4. Rename `dist` directory to your liking and copy it wherever you like.
60
+5. You're done!
61
+
62
+#### Usage
38 63
 
39 64
 You can start the application by issuing the command `application_directory/qsummer` on the command
40 65
 line.
@@ -43,6 +68,3 @@ To preload QSummer with file to check, you have to pass it the file name paramet
43 68
 line, eg. `qsummer -f file_to_check`.
44 69
 
45 70
 You can also create `.desktop` file to run the application with your desktop environment.
46
-
47
-[License](LICENSE)
48
-=======

+ 15
- 0
doc/changelog.md View File

@@ -0,0 +1,15 @@
1
+#### Version 0.9.4 (2017-04-08 CEST)
2
+ * Add '-f' '--file' command line parameter
3
+ * Remove the necessity to use additional bash script
4
+
5
+#### Version 0.9.3 (2017-04-03 CEST)
6
+ * Add file command line parameter handling
7
+ * Select SHA-256 by default
8
+
9
+#### Version 0.9.2 (2017-04-02 CEST)
10
+ * Add Makefile
11
+ * Update licensing and contact information
12
+
13
+#### Version 0.9.1 (2013-06-23 CEST)
14
+ * Add Czech translation; thanks to Pavel Fric \[[fripohled.blogspot.cz](http://fripohled.blogspot.cz)\]
15
+ * 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
- 17
www/changes.wiki View File

@@ -1,17 +0,0 @@
1
-<title>Change Log</title>
2
-
3
-<h2>Changes for Version 0.9.4 (2017-04-08 CEST)</h2>
4
-  *  Add '-f' '--file' command line parameter
5
-  *  Remove the necessity to use additional bash script
6
-
7
-<h2>Changes for Version 0.9.3 (2017-04-03 CEST)</h2>
8
-  *  Add file command line parameter handling
9
-  *  Select SHA-256 by default
10
-
11
-<h2>Changes for Version 0.9.2 (2017-04-02 CEST)</h2>
12
-  *  Add Makefile
13
-  *  Update licensing and contact information
14
-
15
-<h2>Changes for Version 0.9.1 (2013-06-23 CEST)</h2>
16
-  *  Add Czech translation; thanks to Pavel Fric &#91;[http://fripohled.blogspot.cz | fripohled.blogspot.cz]&#93;
17
-  *  Fix minor bugs

+ 0
- 106
www/index.wiki View File

@@ -1,106 +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-qsummer | What is QSummer]
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-qsummer"><h1>What is QSummer?</h1></a>
19
-
20
-QSummer is a simple graphical application used to validate file checksums.<br>
21
-Just run QSummer, 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 Bash, Python 3 and PySide 1.1.0+ are available 
29
-  (though icons will be shown on systems adhering to freedesktop.org
30
-  [http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html|Icon Naming
31
-  Specification] only)
32
-  *  Multilingual (currently Czech, English and Polish languages are available)
33
-  *  Easy to use - has simple graphical interface
34
-
35
-<a name="screenshots"><h1>Screenshots</h1></a>
36
-
37
-<br><center><img src="/doc/trunk/www/img/screenshots/new.png">
38
-<p><i>QSummer is started or "File->New" was chosen from menu</i></p><br><br>
39
-
40
-<img src="/doc/trunk/www/img/screenshots/running.png">
41
-<p><i>QSummer is calculating checksum</i></p><br><br>
42
-
43
-<img src="/doc/trunk/www/img/screenshots/success.png">
44
-<p><i>Calculated checksum matched the pasted one</i></p><br><br>
45
-
46
-<img src="/doc/trunk/www/img/screenshots/fail.png">
47
-<p><i>Calculated checksum did not match the pasted one</i></p></center>
48
-
49
-<a name="install"><h1>Install</h1></a>
50
-
51
-<h3>Requirements</h3>
52
-
53
-1. Build
54
-  *  Make
55
-  *  Python 3
56
-  *  pyside-lupdate from pyside-tools package
57
-  *  lrelease from Qt's Linguist tool chain
58
-
59
-2. Run
60
-  *  Python 3
61
-  *  PySide 1.1.0+ (Python 3 version)
62
-
63
-<h3>Installation</h3>
64
-
65
-Basically there's no need to install QSummer (although lack of installation script makes its version
66
-0.9.4 rather than 1.0) and thus the installation procedure is as follows:
67
-
68
-1. Download sources:
69
-  *  either log in as anonymous user, download compressed archive of chosen check-in and extract
70
-       it to destination directory
71
-  *  or clone repository using `fossil clone` command.
72
-  
73
-2. Go to project directory.
74
-
75
-3. Run `make build`.
76
-
77
-4. Rename `dist` directory to your liking and copy it wherever you like.
78
-
79
-5. You're done!
80
-
81
-<h3>Usage</h3>
82
-
83
-You can start the application by issuing the command `application_directory/qsummer` on the command
84
-line.
85
-
86
-To preload QSummer with file to check, you have to pass it the file name parameter on the command
87
-line, eg. `qsummer -f file_to_check`.
88
-
89
-You can also create `.desktop` file to run the application with your desktop environment.
90
-
91
-<a name="license"><h1>License</h1></a>
92
-
93
-<center>Copyright &copy;2013-2017 Piotr Orzechowski &#91;orzechowski.tech&#93;.<br><br>
94
-
95
-QSummer is free software; you can redistribute it and/or modify<br>
96
-it under the terms of the GNU General Public License as published by<br>
97
-the Free Software Foundation; version 3 of the License.<br>
98
-
99
-QSummer is distributed in the hope that it will be useful,<br>
100
-but WITHOUT ANY WARRANTY; without even the implied warranty of<br>
101
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br>
102
-GNU General Public License for more details.<br>
103
-
104
-You should have received a copy of the GNU General Public License<br>
105
-along with QSummer; if not, write to the Free Software<br>
106
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110–1301 USA</center>