Browse Source

Switch to markdown

master
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 @@
GSummer - Simple checksum validator
===================================
# GSummer - Simple checksum validator

Requirements
============
[What is GSummer](#what-is-gsummer) | [Features](#features) | [Screenshots](#screenshots) |
[Install](#install) | [License](LICENSE) | [Changelog](doc/changelog.md)

1. Build
## What is GSummer?

* Make
* gettext
GSummer is a simple graphical application used to validate file checksums.<br>
Just run GSummer, choose file to validate, select hash algorithm, paste checksum provided by the
file creator and hit "Validate".<br>
Once the validation is finished, you will know whether file is ok or damaged.

2. Run
## Features

* Python 3
* PyGObject 3.4+ (for Python 3)
* gettext
* Support for md5, sha1, sha224, sha256, sha384 and sha512 hash algorithms
* Cross-platform - should be able to run anywhere Python 3, PyGObject 3.4+ and gettext
are available
* Multilingual (currently Czech, English and Polish languages are available)
* Easy to use - has simple graphical interface

Installation
============
## Screenshots

Basically there's no need to install GSummer (although lack of installation script makes its version
0.9.4 rather than 1.0) and thus the installation procedure is as follows:
![new.png](doc/screenshots/new.png)<br>
_GSummer is started or "File->New" was chosen from menu_

![running.png](doc/screenshots/running.png)<br>
_GSummer is calculating checksum_

![success.png](doc/screenshots/success.png)<br>
_Calculated checksum matched the pasted one_

![fail.png](doc/screenshots/fail.png)<br>
_Calculated checksum did not match the pasted one_

## Install

1. Download sources:
#### Requirements

* either log in as anonymous user, download compressed archive of chosen check-in and extract
it to destination directory
* or clone repository using `fossil clone` command.
1. Build
* Make
* gettext

2. Go to project directory.
3. Run `make build`.
4. Rename `dist` directory to your liking and copy it wherever you like.
5. You're done!
2. Run
* Python 3
* PyGObject 3.4+ (for Python 3)
* gettext

Usage
=====
#### Installation

Basically there's no need to install GSummer (although lack of installation script makes its version
0.9.4 rather than 1.0) and thus the installation procedure is as follows:

1. Download sources from `releases` tab.
2. Go to project directory.
3. Run `make build`.
4. Rename `dist` directory to your liking and copy it wherever you like.
5. You're done!

#### Usage

You can start the application by issuing the command `application_directory/gsummer` on the command
line.
@@ -42,6 +65,3 @@ To preload GSummer with file to check, you have to pass it the file name paramet
line, eg. `gsummer -f file_to_check`.

You can also create `.desktop` file to run the application with your desktop environment.

[License](LICENSE)
==================

+ 19
- 0
doc/changelog.md View File

@@ -0,0 +1,19 @@
### Version 0.9.4 (2017-04-09 CEST)
* Select SHA-256 by default

### Version 0.9.3 (2017-04-09 CEST)
* Add '-f' '--file' command line parameter
* Load appropriate gettext implementations on Linux, OSX and Windows
* Fix translations not loaded bug
* Add Makefile

### Version 0.9.2 (2015-09-05 CEST)
* Add file command line parameter handling
* Reset status bar on verification start
* Update copyright notice and license info

### Version 0.9.1 (2013-07-27 CEST)
* Add Czech translation; thanks to Pavel Fric \[[fripohled.blogspot.cz](http://fripohled.blogspot.cz)\]
* Add accelerators to main menu items
* Add icons to verify/cancel button
* 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 @@
<title>Change Log</title>

<h2>Changes for Version 0.9.4 (2017-04-09 CEST)</h2>
* Select SHA-256 by default

<h2>Changes for Version 0.9.3 (2017-04-09 CEST)</h2>
* Add '-f' '--file' command line parameter
* Load appropriate gettext implementations on Linux, OSX and Windows
* Fix translations not loaded bug
* Add Makefile

<h2>Changes for Version 0.9.2 (2015-09-05 CEST)</h2>
* Add file command line parameter handling
* Reset status bar on verification start
* Update copyright notice and license info

<h2>Changes for Version 0.9.1 (2013-07-27 CEST)</h2>
* Add Czech translation; thanks to Pavel Fric &#91;[http://fripohled.blogspot.cz | fripohled.blogspot.cz]&#93;
* Add accelerators to main menu items
* Add icons to verify/cancel button
* Fix minor bugs

+ 0
- 103
www/index.wiki View File

@@ -1,103 +0,0 @@
<title>Home</title>

<center><p><small><i>Simple checksum validator</i></small></p></center>

<table align="right">
<tr><td>
<ul><br>
<li> [#what-is-gsummer | What is GSummer]
<li> [#features | Features]
<li> [#screenshots | Screenshots]
<li> [#install | Install]
<li> [#license | License]
<li> [./changes.wiki | Change Log]
</ul>
</td></tr>
</table>

<a name="what-is-gsummer"><h1>What is GSummer?</h1></a>

GSummer is a simple graphical application used to validate file checksums.<br>
Just run GSummer, choose file to validate, select hash algorithm, paste checksum provided by the
file creator and hit "Validate".<br>
Once the validation is finished, you will know whether file is ok or damaged.

<a name="features"><h1>Features</h1></a>

* Support for md5, sha1, sha224, sha256, sha384 and sha512 hash algorithms
* Cross-platform - should be able to run anywhere Python 3, PyGObject 3.4+ and gettext
are available
* Multilingual (currently Czech, English and Polish languages are available)
* Easy to use - has simple graphical interface

<a name="screenshots"><h1>Screenshots</h1></a>

<br><center><img src="/doc/trunk/www/img/screenshots/new.png">
<p><i>GSummer is started or "File->New" was chosen from menu</i></p><br><br>

<img src="/doc/trunk/www/img/screenshots/running.png">
<p><i>GSummer is calculating checksum</i></p><br><br>

<img src="/doc/trunk/www/img/screenshots/success.png">
<p><i>Calculated checksum matched the pasted one</i></p><br><br>

<img src="/doc/trunk/www/img/screenshots/fail.png">
<p><i>Calculated checksum did not match the pasted one</i></p></center>

<a name="install"><h1>Install</h1></a>

<h3>Requirements</h3>

1. Build
* Make
* gettext

2. Run
* Python 3
* PyGObject 3.4+ (for Python 3)
* gettext

<h3>Installation</h3>

Basically there's no need to install GSummer (although lack of installation script makes its version
0.9.4 rather than 1.0) and thus the installation procedure is as follows:

1. Download sources:
* either log in as anonymous user, download compressed archive of chosen check-in and extract
it to destination directory
* or clone repository using `fossil clone` command.
2. Go to project directory.

3. Run `make build`.

4. Rename `dist` directory to your liking and copy it wherever you like.

5. You're done!

<h3>Usage</h3>

You can start the application by issuing the command `application_directory/gsummer` on the command
line.

To preload GSummer with file to check, you have to pass it the file name parameter on the command
line, eg. `gsummer -f file_to_check`.

You can also create `.desktop` file to run the application with your desktop environment.

<a name="license"><h1>License</h1></a>

<center>Copyright &copy;2013-2017 Piotr Orzechowski &#91;orzechowski.tech&#93;.<br><br>

GSummer is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; version 3 of the License.<br>

GSummer is distributed in the hope that it will be useful,<br>
but WITHOUT ANY WARRANTY; without even the implied warranty of<br>
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br>
GNU General Public License for more details.<br>

You should have received a copy of the GNU General Public License<br>
along with GSummer; if not, write to the Free Software<br>
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110–1301 USA</center>

Loading…
Cancel
Save