SansTerminalIndexer/README.md

# Sans Terminal Indexer
This is a program currently in development that I am creating to help make indexing of SANS textbooks easier that is based off of [Voltaire](https://voltaire.publickey.io/). 

Currently the indexer has the following features
- Checks to see if you have any indexes in the current directory (Checks for .csv files)
    - If so it will ask you to select which index you would like to use, if not it will create a new one.
- Takes input in the format of **Term, page number**. The two fields can be any an information you want in your index but it must be delimited by commas.
- Your index will be saved in ~/.Indexes



# Images

![sansterminalindex](https://user-images.githubusercontent.com/19278569/198133246-16d24198-b968-4beb-8d0e-c7a88ac430c2.png)

![createCsv](https://user-images.githubusercontent.com/19278569/198133658-1eca6c0f-7859-43e6-9f6d-faecde6ca89a.gif)

![createIndex](https://user-images.githubusercontent.com/19278569/198133817-707ba25e-4990-4251-9ece-f6161b9db40a.gif)

![indexDisplay](https://user-images.githubusercontent.com/19278569/198133680-a070ef38-12bc-47dd-b6ef-f086bb1c7e8f.gif)

# Todo
- ~~Add index viewer within program (Pretty print index.csv)~~
- Add edit feature (edit previous index entries)
- Add CSV sorting (Sort by book then alphabetical)
- Add handling for repeat entries
- ~~Add "Create new" option to csv selection option~~
- ~~Create a .index file in home directory that stores indexes~~
- Add delete option for index files
- ~~Add "ask for book" prompt on startup~~
- ~~Allow for input with no definition (term, pagenumber)~~
- ~~Remove definition support (I found this was redundant and not helpful for an index)~~