FileCypher / README.md
Table of Contents
About
FileCypher is a desktop program that allows you to cypher and decypher files directly from the CLI.
Built With
Getting Started
This application doesn't include a compiled executable file to run on an desktop device, instead you must compile it yourself.
System Requirements
To run the app you need:
- A desktop device running any OS.
- At least 30 MB of free space.
Installation
After compiling the app with the source code, just run the resulting executable using the terminal to start using.
Development
In order to compile or develop the FileCypher app on your device, you will need to follow the steps below.
Prerequisites
In order to run the application, you will need the following tools:
- IntelliJ IDEA (or similar);
- git (optional).
Installation
- Clone the repository
git clone https://github.com/D3W10/FileCypher.git - Open the project folder using your prefered IDE (ex: IntelliJ IDEA)
- Wait for the project to fully load
- After setting up the command line arguments, run the app by clicking on the green play button in the top right corner
License
Distributed under the MIT license. Check LICENSE for more details.
Credits
- Made by Daniel Nunes