diff --git a/README.md b/README.md index 9d43344..49769d2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # 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/). +Sans terminal indexer is a program that I have been using for the last couple of months decrease the amount of time it takes to create an index from a $ANS book, although it could be used for any book you need to create an index of. The goal of this project is to create a very fast/efficient way to create an index. This program was greatly inspired by Matthew Toussain's [Voltaire](https://voltaire.publickey.io/) and Lesley Carhart's [Better GIAC testing With Pancakes](https://tisiphone.net/2015/08/18/giac-testing/) -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 +Currently the indexer has the following features are implemented +- Creates/stores index in `~/.Indexes` folder +- Takes input in the format of **Term, page number**. +# Install + +```bash +git clone https://github.com/grahamhelton/SansTerminalIndexer +cd SansTerminalIndexer +pip3 install pandas +./index.py +``` # Images @@ -15,18 +21,8 @@ Currently the indexer has the following features ![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)~~ +For the most part, this tool is complete. However, I would like to add the following features if I have time. - 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)~~