#annotations #tui #notes #user-interface #ncurses #jot

app jotspot

一个通用的基于文本的用户界面(TUI)工具,旨在简化注释过程

1 个不稳定版本

0.1.0 2023年9月24日

#653 in GUI

MIT 许可证

23KB
151

Jotspot - 文本注释工具

Jotspot 是一个简单的文本注释工具,允许您创建和管理带时间戳的文本注释。无论您是想快速记下笔记、记录重要事件的日期,还是简单地注释文本以供将来参考,Jotspot 都能满足您的需求。

功能

  • 创建注释:轻松创建带时间戳的文本注释。
  • 时间戳:注释包括表示创建时间的时戳。
  • 用户友好的界面:直观且用户友好的基于文本的界面,用于注释管理。
  • 查看注释列表:方便地查看和管理您的注释。
  • 可定制:根据您的喜好定制注释文本。
  • 时间戳格式化:Jotspot 提供用户友好的时间戳格式化,如 "X 秒前",使您易于理解注释的创建时间。

入门指南

先决条件

在开始之前,请确保已安装以下软件

  • Rust(如果您还没有,可以从这里获取
  • Git(用于克隆仓库)

安装

  1. 将 "jotspot" 仓库克隆到您的本地计算机

    git clone https://github.com/ricardofares/jotspot.git
    
  2. 切换到 "jotspot" 项目的目录

    cd jotspot
    
  3. 构建项目

    cargo build --release
    

因此,项目二进制文件可以在 target/release/ 目录中找到。

用法

使用 jotspot 命令后跟您的文本来创建新的注释。例如

./jotspot "This is my first annotation."

不带参数运行 jotspot 以进入交互式注释界面

./jotspot

使用交互式界面查看和管理您的注释。

贡献

欢迎贡献!如果您想为 Jotspot 做贡献,请按照以下步骤操作

  1. 复制仓库。
  2. 为您的功能或错误修复创建一个新的分支。
  3. 进行更改并使用清晰、简洁的消息提交更改。
  4. 将您的更改推送到您的分支。
  5. 向主仓库提交拉取请求。

致谢

  • Cursive TUI 库,为用户提供界面组件。
  • Rust 社区,因为它创建了一个强大而高效的编程语言。

依赖关系

~6MB
~101K SLoC