Skip to content

Commit 78e2201

Browse files
Merge pull request #9 from authxt/main
fix: change application name NoteCLI
2 parents 3ae61fd + bd1e698 commit 78e2201

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
# Document Management System (DMS)
1+
# Notepad Command Line Base (NoteCLI)
22

3-
A command-line based Document Management System written in C that allows users to create, read, update, and delete text documents organized in categories. The system includes automatic versioning and comprehensive operation logging.
3+
A command-line based notepad app written in C that allows users to create, read, update, and delete textfile organized in categories. The system includes automatic versioning and comprehensive operation logging.
44

55
## Features
66

7-
- Create new text documents in different categories
8-
- Read existing documents
9-
- Update document content with automatic version backup
10-
- Delete documents
7+
- Create new text textfile in different categories
8+
- Read existing textfile
9+
- Update textfile content with automatic version backup
10+
- Delete textfile
1111
- Organized file structure with categories
12-
- Version history for edited documents
12+
- Version history for edited textfile
1313
- Complete operation logging with timestamps
1414
- Error handling and input validation
1515
- Color-coded console output
16-
- Clean all documents with history preservation
16+
- Clean all textfile with history preservation
1717

1818
## Directory Structure
1919

2020
```
21-
DocumentManager/
21+
NoteCLI/
2222
├── bin/ # Compiled binary
2323
├── src/ # Source code files
2424
├── include/ # Header files
25-
├── data/ # Document storage
26-
│ ├── recipes/ # Recipe documents
27-
│ ├── notes/ # Note documents
25+
├── data/ # textfile storage
26+
│ ├── recipes/ # Recipe textfile
27+
│ ├── notes/ # Note textfile
2828
│ ├── logs/ # Operation logs and history
2929
│ │ └── history.txt # Complete operation history
3030
│ └── versions/ # Automatically saved old versions
@@ -47,15 +47,15 @@ To clean the build files:
4747
make clean
4848
```
4949

50-
To clean all documents while preserving history:
50+
To clean all textfile while preserving history:
5151

5252
```bash
5353
make clean-docs
5454
```
5555

5656
This will:
5757
1. Ask for confirmation before proceeding
58-
2. Remove all documents in notes, recipes, and versions directories
58+
2. Remove all textfile in notes, recipes, and versions directories
5959
3. Preserve the operation history in data/logs/history.txt
6060
4. Log the cleanup operation with timestamp
6161

@@ -66,29 +66,29 @@ This will:
6666
The DMS supports the following commands:
6767

6868
```bash
69-
# Create a new document
69+
# Create a new textfile
7070
./bin/dms create <category> <filename>
7171

72-
# Read a document
72+
# Read a textfile
7373
./bin/dms read <category> <filename>
7474

75-
# Update a document
75+
# Update a textfile
7676
./bin/dms update <category> <filename>
7777

78-
# Delete a document
78+
# Delete a textfile
7979
./bin/dms delete <category> <filename>
8080
```
8181

8282
### Available Categories
83-
The system organizes documents into these categories:
83+
The system organizes textfile into these categories:
8484
- `recipes` - For storing cooking recipes
8585
- `notes` - For general notes and todos
8686
- `logs` - For logs and records
8787

8888
### How to Use
8989

90-
#### 1. Creating Documents
91-
There are two ways to create documents:
90+
#### 1. Creating textfile
91+
There are two ways to create textfile:
9292

9393
a. Interactive Mode:
9494
```bash
@@ -101,14 +101,14 @@ b. Using Echo (for quick creation):
101101
echo "My content here" | ./bin/dms create notes quick-note.txt
102102
```
103103

104-
#### 2. Reading Documents
105-
To read any document:
104+
#### 2. Reading textfile
105+
To read any textfile:
106106
```bash
107107
./bin/dms read notes todo.txt
108108
```
109109

110-
#### 3. Updating Documents
111-
When you update a document, the old version is automatically saved in the versions directory:
110+
#### 3. Updating textfile
111+
When you update a textfile, the old version is automatically saved in the versions directory:
112112

113113
a. Interactive Mode:
114114
```bash
@@ -123,8 +123,8 @@ echo "Updated content" | ./bin/dms update notes todo.txt
123123

124124
The old version will be saved as: `data/versions/notes_YYYYMMDD_HHMMSS_todo.txt`
125125

126-
#### 4. Deleting Documents
127-
To delete a document (will ask for confirmation):
126+
#### 4. Deleting textfile
127+
To delete a textfile (will ask for confirmation):
128128
```bash
129129
./bin/dms delete notes todo.txt
130130
```
@@ -143,7 +143,7 @@ Example log entries:
143143
[2025-05-24 20:56:07] READ: notes/todo.txt
144144
[2025-05-24 20:56:15] UPDATE: notes/todo.txt
145145
[2025-05-24 20:56:19] DELETE: notes/todo.txt
146-
[2025-05-24 21:00:00] CLEAN-DOCS: All documents cleared (notes, recipes, versions)
146+
[2025-05-24 21:00:00] CLEAN-DOCS: All textfiles cleared (notes, recipes, versions)
147147
```
148148

149149
To view the operation history:
@@ -153,7 +153,7 @@ cat data/logs/history.txt
153153

154154
### Version Control
155155

156-
- All document updates are automatically versioned
156+
- All textfile updates are automatically versioned
157157
- Old versions are stored in `data/versions/`
158158
- Version files are named using the format: `category_YYYYMMDD_HHMMSS_filename`
159159
- You can access old versions directly in the versions directory
@@ -202,7 +202,7 @@ echo "1. Buy groceries - DONE
202202
- Hyphens (-)
203203
- Underscores (_)
204204
- Directory traversal is not allowed in filenames
205-
- Maximum input size for document content is 4KB
205+
- Maximum input size for textfile content is 4KB
206206

207207
### Error Handling
208208

@@ -220,11 +220,11 @@ The system provides clear error messages for:
220220
### Tips
221221
222222
1. Use meaningful filenames that describe the content
223-
2. Check the versions directory for document history
223+
2. Check the versions directory for textfile history
224224
3. Review the operation history in `data/logs/history.txt` to track all actions
225225
4. Use the appropriate category for better organization
226226
5. Make sure to press Ctrl+D after entering content in interactive mode
227227
6. For multiline content, using echo with newlines (\n) is recommended
228-
7. Check both version backups and operation logs for complete document history
228+
7. Check both version backups and operation logs for complete textfile history
229229
230230
-->

0 commit comments

Comments
 (0)