File	Date	Author	Commit
src	2013-11-08	Ryan Babb	[bb91da] remove default arg from xor_scramble() implemen...
.gitignore	2013-11-08	Ryan Babb	[2d2cd6] add tasks to TODO ; fix tar.gz typo in .gitignore
AUTHORS	2013-10-29	Ryan Babb	[ef5196] first commit
LICENSE.md	2013-11-06	Ryan Babb	[3121fe] Merge branch 'master' of https://github.com/rya...
README	2013-11-07	Ryan Babb	[430996] fixed README
TODO	2013-11-08	Ryan Babb	[1f558f] remove 'separate encryption task'

Read Me

File Obfuscator v0.1

* ABOUT *
---------
File Obfuscator is a simple programme that provides a thin layer of protection
against unwanted users peeking at your files by scrambling their contents
acoording to a passsword.


* INSTALLATION *
----------------
Install by the standard GNU Build chain.

Open a terminal in the extracted FileObfuscator-0.1 folder. Now type:
	./configure
	make
	sudo make install
	
If you don't have root priviliges, pass the '--prefix=$HOME' (without quotes)
to the 'configure' script, and run 'make install' without 'sudo':
	./configure --prefix=$HOME
	make
	make install
	
Read the INSTALL file for more details.

* UNINSTALLATION *
------------------
Open a terminal in the FileObfuscator-0.1 folder and run:
	make uninstall
	
This should remove the programme from your system.


* USAGE *
---------
Use is quite simple, as the application runs with a Graphical User Interface
or GUI, for short.

You will be presented with 2 text boxes:
	- File: Path to the file to encrypt/decrypt
	- Key: A password to encrypt/decrypt the file
	
Click the Scramble button to create an encrypted file (it will only be active
when both the File and Key entrys have text) with the same name and a '.obf'
extension. For example:

	Joe Hacker has a 'secret' file on his desktop he wishes to protect from
	prying eyes, so he runs 'fileobfuscator' and fills in the form,
	| File: /home/jhacker/Desktop/secret |   and   | Key: mypass |
	Now he clicks on Scramble and a 'secret.obf' file appears on his desktop.
	When he wants to retrieve his original file he repeats the process,
	| File: /home/jhacker/Desktop/secret.obf |   and   | Key: mypass |
	This creates a new file 'secret.obf.obf' just like 'secret'.
	
	
* LICENSE *
-----------
This programme is Free Software and is released under the GPLv3 license. You
have a copy of this license named COPYING in the same directory as this README.

Basically, you are free to
	* USE the programme however YOU want
	* GIVE the programme to whoever YOU want
	* CHANGE the programme to fit YOUR needs
	* DISTRIBUTE your CHANGES to anyone
NOTE: A copy of the license (COPYING file) must allways acompany this programme
to guarantee all users the same rights.


* DEVELOPMENT *
---------------
Please send any bug reports or suggestions to Ryan Babb <ryan221b@gmail.com>

If you are a programmer and are interested in cotributing to the project,
I encourage you to do so. The full and latest source code is available on
GitHub: https://github.com/ryan221b/file-obfuscator
SourceForge: https://sourceforge.net/projects/file-obfuscator/