threeoh6000/mindcap
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readmes

Browse source
This commit is contained in:
abbie 2022-04-07 22:03:26 +01:00
parent 9d09384b25
commit a8d0c2eebb
No known key found for this signature in database
GPG key ID: 04DDE463F9200F87
3 changed files with 99 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README Normal file
View file

@ -0,0 +1,46 @@
mindcap
-----------
(mind)storm (cap)ture is a minimal note taking application.
It isn't visual but entirely text based.
Usage
---------
Running mindcap without a file will result in crashes when attempting to (w)rite.
(r)ead - outputs the notes in memory
(a)ppend - takes an input and adds it to notes in memory
(d)elete - takes a number input and deletes it from the notes in memory
(w)rite - writes the notes in memory to disk
(q)uit - self-explanatory.
When (d)eleting, the number you use will be the note number.
`
note 1
note 2
note 3
`
To delete the second note you input 2, not 1.
You then end up with
`
note 1
note 3
`
How are my notes stored?
----------------------------
Stored in a plaintext document of the name you stored.
They'll be stored in a format similar to this:
`
Welcome to mindcap!|~##~|This is a note!|~##~|This is also a note!
`

44
README.html Normal file
View file

@ -0,0 +1,44 @@
<h2>mindcap</h2>
<p>(mind)storm (cap)ture is a minimal note taking application.
</p>
<p>It isn't visual but entirely text based.
</p>
<h2>Usage</h2>
<p>Running mindcap without a file will result in crashes when attempting to (w)rite.
</p>
<p>(r)ead - outputs the notes in memory
</p>
<p>(a)ppend - takes an input and adds it to notes in memory
</p>
<p>(d)elete - takes a number input and deletes it from the notes in memory
</p>
<p>(w)rite - writes the notes in memory to disk
</p>
<p>(q)uit - self-explanatory.
</p>
<p>When (d)eleting, the number you use will be the note number.
</p>
<p>`</p>
<p>note 1</p>
<p>note 2</p>
<p>note 3</p>
<p>`
</p>
<p>To delete the second note you input 2, not 1.
</p>
<p>You then end up with
</p>
<p>`</p>
<p>note 1</p>
<p>note 3</p>
<p>`
</p>
<h2>How are my notes stored?</h2>
<p>Stored in a plaintext document of the name you stored.
</p>
<p>They'll be stored in a format similar to this:
</p>
<p>`</p>
<p>Welcome to mindcap!|~##~|This is a note!|~##~|This is also a note!</p>
<p>`
</p>

17
README.md
View file

@ -1,5 +1,5 @@
# mindcap ## mindcap
**mind**storm **cap**ture is a minimal note taking application. (mind)storm (cap)ture is a minimal note taking application.
It isn't visual but entirely text based. It isn't visual but entirely text based.
@ -18,26 +18,27 @@ Running mindcap without a file will result in crashes when attempting to (w)rite
When (d)eleting, the number you use will be the note number. When (d)eleting, the number you use will be the note number.
``` `
note 1 note 1
note 2 note 2
note 3 note 3
``` `
To delete the second note you input 2, not 1. To delete the second note you input 2, not 1.
You then end up with You then end up with
``` `
note 1 note 1
note 3 note 3
``` `
## How are my notes stored? ## How are my notes stored?
Stored in a plaintext document of the name you stored. Stored in a plaintext document of the name you stored.
They'll be stored in a format similar to this: They'll be stored in a format similar to this:
``` `
Welcome to mindcap!|~##~|This is a note!|~##~|This is also a note! Welcome to mindcap!|~##~|This is a note!|~##~|This is also a note!
``` `