diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ef2c8e --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ +![](https://1.bp.blogspot.com/-R6PltDejpuI/YAPnPF0MtQI/AAAAAAAAdts/gVdzSVprxVARGa8uedsvM0E1y3LW61bxgCLcBGAsYHQ/s0/aaaaa.gif) + +Share files, chat, and remote terminal with your friends in the LAN network. Easy to use and zero-configuration. + + +## Getting Started + +Download from the [release](https://github.com/sontx/dropzone/releases) page or checkout the latest code from this repo and build by yourself (need [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/)) + +### Prerequisites + +- [Net Framework 4.6.1](https://www.microsoft.com/en-us/download/details.aspx?id=49981) + +### Build + +1. Clone the repo + ```sh + git clone https://github.com/sontx/dropzone.git + ``` +2. Open with [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) +3. Select profile `Release` and from menu `Build` -> `Build Solution` +4. Binary file will be place in `bin/Release` + + + + +## Usage + +Once you and your friends run `DropZone`, this tool will show who is online in the status bar. +![](https://1.bp.blogspot.com/-1NXToJFbRJE/YAPfsR9QrHI/AAAAAAAAds0/Tbfljhu4sjoBedwqLYIDS-hQW7nUwXj3wCLcBGAsYHQ/s0/Capture2.PNG) + +### Share files +There are two ways to share files with your friends: +- Share with everyone who is online: drop files or folder to the tool. +- Share with a individual friend: click on online friends in the status bar and select `Send Files`. +![](https://1.bp.blogspot.com/-vvHzosrISOo/YAPhSm5zf5I/AAAAAAAAdtA/MlB22lAoNw4cNAjGF3FUshnppzxhlv7sQCLcBGAsYHQ/s0/Capture3.PNG) + +Once files are received successfully, a notification will be shown by default (you can turn it off in the settings window). + +![](https://1.bp.blogspot.com/-ZLuRymORNv4/YAPi-sGkXcI/AAAAAAAAdtU/yInwesZx_MM8bDRDrciQlJuxaRPjNRaBgCLcBGAsYHQ/s0/Capture5.PNG) + +### Chat +Click on online friends and select `Chat`, you can also send files in the chat window. +![](https://1.bp.blogspot.com/-cFlxWZs62jw/YAPiQgCKI6I/AAAAAAAAdtI/Z0EKSymQDCQ5cTdB5N02BqeuPwhoO5YnQCLcBGAsYHQ/s0/Capture4.PNG) + +### Remote Terminal +This is a simple remote terminal which will execute your command in your friend `cmd`. Click on online friends and select `Terminal` to start a terminal session. +![](https://1.bp.blogspot.com/-_AB1nH_bUmA/YAPkxzA02HI/AAAAAAAAdtg/-j58xwI0ckMbBc6jcVWdJE9lxEnOzImMgCLcBGAsYHQ/s0/aaaa.gif) + + +## Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + + + +## License + +Distributed under the MIT License. See `LICENSE` for more information. + + + + +## Contact + +Tran Xuan Son - [@sontx0](https://twitter.com/sontx0) - xuanson33bk@gmail.com + +Project Link: [https://github.com/sontx/dropzone](https://github.com/sontx/dropzone)