---

Rust JSON Note Manager

A simple command-line tool for managing JSON Notes built using Rust.

---

Table of Contents

• Features
• Getting Started
  • Installation
  • Usage
• What's Inside?
• Resources
• License
• Credits

Features

The project will use the serde and serde_json crates for serialization and deserialization, allowing users to store notes in a JSON file.

Getting Started

Installation

1. Clone the Repository:

git clone https://github.com/scottgriv/rust-json_note_manager

2. Change to the Directory:

cd rust-json_note_manager

3. Build the Project:

cargo build --release

4. Run the Command:

cargo run -- <command> [arguments]

5. Example:

cargo run -- add "This is a new note"

Usage

• Add a note: cargo run -- add "Your note content"
• List notes: cargo run -- list
• Delete a note by ID: cargo run -- delete <note_id>

Note

Your notes will be stored in a file called notes.json in the same directory as the executable.

What's Inside?

rust-note-manager/ # Root directory
├── src/ # Source code
│   ├── main.rs # For running the program
│   ├── notes.rs # For managing notes
│   └── commands.rs # For parsing command-line arguments
├── sample/ # Sample data
│   └── notes_sample_output.json # Sample data
├── target/ # Generated
├── notes.json # Generated notes file
├── Cargo.toml # Dependencies
├── .gitignore # git ignore file
├── LICENSE # License file
└── README.md # This file

Resources

• Rust
• Rust Book
• Rust Documentation
• Rust Playground
• Rust Crates

License

This project is released under the terms of The Unlicense, which allows you to use, modify, and distribute the code as you see fit.

• The Unlicense removes traditional copyright restrictions, giving you the freedom to use the code in any way you choose.
• For more details, see the LICENSE file in this repository.

Credits

Author: Scott Grivner
Email: scott.grivner@gmail.com
Website: scottgrivner.dev
Reference: Main Branch

---