From 8a87e46bc837881294d1d0fa70dd69fa0135044f Mon Sep 17 00:00:00 2001 From: Graham Helton Date: Wed, 26 Oct 2022 16:45:23 -0400 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b6a5a6d..0d0eee5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,20 @@ This is a program currently in development that I am creating to help make index 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 three fields can be any an information you want in your index but it must be delimited by commas. -- You index is saved in the directory the program is launched from everytime you enter a new entry +- 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)~~ @@ -23,4 +32,3 @@ Currently the indexer has the following features - ~~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)~~ -