Siqi

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Creating a super simple task cli tool.

My longterm goal is to build a simple cli tool which will store tasks in a default.task file in the current directory. Publish / Update tasks from default file into README.md.

Also nice to have everything it git. Alot of the tools are using a databases or a special file format which make things just bloated or complitcated. That's why I am just using a simple .yaml notation

I might end up loading every *.task file or make a config file for that but at the moment i dont even know if i will go that far with this.

Initial thoughts: Project Management Tools are nice and super helpfull but they take alot of effort to setup and customize. Alot of the time the best way to star a project is by "just do it!". For that is like init git and create a readme.md file. I always end up bulding a todo.txt or todo.md or write the first todos as comments straight into my code file. To standardize this process i am creating this simple tool.

Let's see if it will be handy and where the jorney takes me.

P.S.: I want to learn rust and this is my project to do so. P.P.S: This might be a do and forget forever project. Only the universe can tell if there will ever be a 1.0 release version.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Neovim
• rust-analyzer
• rust
• Nix

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• make sure you have a cli installed e.g. bash, sh, zsh, powershell

Installation

1. Clone the repo

   git clone https://github.com/CyberT3C/siqi

2. Build

   nix-build

(back to top)

Usage

Usage: command [options] <arguments>

Options
    list
    add <task-name>
    done <index>

# e.g.
siqi add "this is a new task"
siqi done 1
siqi list

Docs - missing link

(back to top)

Roadmap

• Initial Readme
• Create local POC
• Create Alpha Version
  • Build a task list
  • Save to file
  • Read from file
  • Add task
  • Delete task
  • View all tasks
  • Mark task as done
  • Uncheck done task
  • Create cli integration
    • Add MoveUp Feature
    • Add MoveDown Feature
• Build with nix
• Release v0.1
• Create v0.2
  • Feature: Sync between .task. file and [Roadmap] in README.md
  • Code Review
  • Refactor Codebase
  • Add Changelog
• Release v0.2 for multiple OSs
  • Support support for
    • Linux
    • Windows
    • Mac

My longterm goal is to build a simple cli tool which will store tasks in a default.task file in the current directory. Publish / Update tasks from default.task file into README.md

Dreams: Integrate this tool with other task / project management tools, like Github, Gitlab or Jira.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

CyberT3C - missing link

Project Link: https://github.com/CyberT3C/siqi

(back to top)

Acknowledgments

Resources which are helpful and would like to give credit to!

• Choose an Open Source License

(back to top)