search

spsdco / notes

Awesome note taking.
MIT License
560 stars 54 forks source link

man page availability #145

Open nitishch opened 10 years ago

nitishch commented 10 years ago

There is no man page for springseed. It would be helpful to have a man page explaining basic markdown syntax and about basic note taking facilities in springseed like new note creation, category creation etc.

melamity commented 10 years ago

That could be something we can look at. Do you have any sort of draft for what could be included in this manpage?

nitishch commented 10 years ago

I just have an idea of what can be included in the man page

Synopsis

(How to invoke springseed from commandline)

Description of the application

Command line arguments that can be passed.

(I don't know about the command line arguments facility while running with atom-shell, but when I installed using .deb file from website, I can open app using springseed command. This can have command line arguments)

Notes and categories.

Files and Directories.

(Here, details like where notes are stored and locations of config files (if any, I don't know) can be explained

Sync

(Details of sync with Dropbox)

Markdown Syntax.

(Here the markdown syntax supported by springseed can be explained)

Resources

Author

License