Skip to content

Commit

Permalink
Better README
Browse files Browse the repository at this point in the history
  • Loading branch information
ViktorPopp committed Aug 13, 2024
1 parent f9d65d4 commit 19cdad4
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 5 deletions.
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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** <br>
There a as always prebuild binaries for windows on the releases page. <br>

**Linux** <br>
Linux is currently not supported. See how to build it yourself in the [Build Guide](#build-guide) <br>

## 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** <br>
```console
> cd Scripts && GenVisualStudio2022.bat # Choose 2019 for VS2019
```
Open Todo-App.sln and build the project.

**Linux** <br>
Requirements: Premake installed and added to path. <br>
```console
$ premake5 gmake # Can also use gmake2
$ make
```
4 changes: 0 additions & 4 deletions Source/TodoList.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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() {
Expand Down

0 comments on commit 19cdad4

Please sign in to comment.