Metadata-Version: 2.1
Name: nestingnote
Version: 0.0.11
Summary: Terminal note-taking application
Home-page: https://github.com/woodsonmiles/nesting-note
Author: Woodson Miles
Author-email: woodomiles@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >3.6
Description-Content-Type: text/markdown
Requires-Dist: windows-curses (==2.1.0) ; platform_system == "Windows"

### Installation
- Windows
  1. [Download](https://github.com/woodsonmiles/nestingnote/raw/master/dist/nestingnote.exe)
- Linux (varies per distro)
  1. Install Python3<br>
    `sudo apt install python3`
  1. Install pip for Python3
  1. install nestingnote<br>
    `python3 -m pip install nestingnote`
  1. create alias (for convenience)<br>
    ```
    echo "alias nestingnote='python3 -m nestingnote'" >> ~/.bash_aliases
    source ~/.bash_aliasees
    ```    
### Execution
```python3 -m nestingnote \path\to\my\notes```
### Controls
Most controls are intuitive, e.g., all printable keys insert that character, arrow keys, home, end, page up, and page down all move the cursor appropriately. However, there are a few special controls introduced by nestingnote:
- **Tab**: at the beginning of a line will indent the line, starting an inner nested list. Within the line, tab will split the line into fields similar to columns in a matrix.
- **Ctrl+k**: toggles whether the current item in the nested list is collapsed, meaning that all items nested beneath it are hidden.
- **Ctrl+w**: save the edits


