diff --git a/README.md b/README.md index af61fbb..faa56d5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ # Todo-App -A todo app suited for everyone +This to-do app is a small project made by me (**@ViktorPopp**) and is currently only supporting the command line but will eventually be supporting GUI applications. + +## Features +* ➕ Add todo's +* ✅ Check todo's +* 📄 Have multiple lists +* ❌ Remove todo's + +## Installation +**Windows**
+There a as always prebuild binaries for windows on the releases page.
+ +**Linux**
+Linux is currently not supported. See how to build it yourself in the [Build Guide](#build-guide)
+ +## Usage +A simple guide on using this to-do app: +```console +> To-do-App.exe list.txt # Open the app and open and/or create a list +> Enter a command: new # Create a new to-do +> Enter a title: Release Todo-App +> Enter a description: Go to GitHub releases and create a new release + +> Enter a command: check # Check a to-do +> Enter an index number: 1 # Remember it starts from 0 + +> Enter a command: list # show all the to-do's +> [ ] Release Todo-App: Go to GitHub releases and create a new release +> [x] Create README.md: Create the README file to the Todo-App repo. Add Features, Installation, Usage and Build Guide. + +> Enter a command: rm # Remove a to-do +> Enter an index number: 1 +``` + +## Build Guide +**Windows**
+```console +> cd Scripts && GenVisualStudio2022.bat # Choose 2019 for VS2019 +``` +Open Todo-App.sln and build the project. + +**Linux**
+Requirements: Premake installed and added to path.
+```console +$ premake5 gmake # Can also use gmake2 +$ make +``` \ No newline at end of file diff --git a/Source/TodoList.cpp b/Source/TodoList.cpp index 7307a98..8b925bf 100644 --- a/Source/TodoList.cpp +++ b/Source/TodoList.cpp @@ -5,7 +5,6 @@ TodoList::TodoList(const std::string& filename) : filename(filename) { } void TodoList::LoadTodos() { - std::cout << "Loading todos from file: " << filename << "\n"; std::ifstream file(filename); if (file.is_open()) { Todo todo; @@ -14,9 +13,6 @@ void TodoList::LoadTodos() { } file.close(); } - else { - std::cout << "Failed to open file. If the file not exists it will be created and you should ignore this\n"; - } } void TodoList::SaveTodos() {