Skip to content

Commit e7a8f59

Browse files
Updated readme for release (#5)
* Updated readme file for new release
1 parent b530da6 commit e7a8f59

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,43 @@ This tool does not download data.
44

55
## FAQ
66

7-
### How to use this?
7+
### Usage
8+
![App Screenshot](https://github.com/touchofevil-dev/BhavcopyEasy/blob/master/Images/BhavcopyEasy-Image.jpg)
9+
10+
1. Select date for which you want to generate data.
11+
2. Select folder in which you've both the data files (i.e. cash market and index).
12+
3. Select folder in which you'd like to generate the file.
13+
4. Click on Generate file.
14+
5. If it works, it will open the folder with data.
15+
6. If you get any error, it would show on screen and generate an ErrorLog file. You can use the ErrorLog.txt file to raise an issue on this repo.
16+
17+
18+
### How to Install?
819

920
#### Prerequisites
1021
This application requires Dotnet 6 or above. Please download the dotnet framework runtime from [Microsoft Website](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) if you don't have it.
1122
You only need .Net runtime (win x64 or win x86 according to your machine).
1223

13-
#### Steps (v0.1.1-alpha) -
24+
### Installation
25+
Download the .msix file from Releases and install. Fairly straight forward.
26+
27+
#### If Installation button is disabled
28+
If the Install button is disabled, check the steps below to resolve the error.
29+
1. Right click on the .msix file.
30+
2. Select digital signatures tab.
31+
3. Select signer with name touchofevil and click on Details
32+
4. Click on View Certificate.
33+
5. Click on Install Certificate.
34+
6. Select Local Machine and click next. Provide admin permission, if needed.
35+
7. Select Place certificate in following store and click on browse.
36+
8. Scroll down and select 'Trusted People' and click Ok.
37+
9. Click next and click on Finish.
38+
10. You should get successful import dialog. Click on ok and close open windows if any.
39+
11. Rerun the installer.
40+
41+
[Refere to Microsoft guideline](https://learn.microsoft.com/en-us/dotnet/maui/windows/deployment/publish-cli#installing-the-app) if needed.
42+
43+
#### Older console versions -
1444
1. Download data files to a folder. No need to extract the zip any longer. Preferably do not download in C:\\. If you only have C:, then create a folder on Desktop and put everything there.
1545
2. Download released zip file and extract the contents to same folder as above.
1646
3. Edit batch file using notepad, and update below fields carefully.
@@ -30,11 +60,10 @@ You only need .Net runtime (win x64 or win x86 according to your machine).
3060
If everything is successful, it should create a .txt file in same folder.
3161
If you see ErrorLog.txt file generated instead, please raise a bug and attach that file to bug.
3262

33-
### Notes
34-
1. Only download from official releases from the repo -
3563

36-
Being very honest about it, in its current state its extremely easy to wrap malware around it. Don't risk by downloading from unknown sources. Also always scan with antivirus before running to be safe.
64+
### Notes
65+
1. Only download from official releases from the repo.
3766
2. Do not redistribute. Download only from the releases on repo.
3867
3. No liability with the author. Run at your own risk. Author shall bear no responsibility for any damages or losses.
3968
4. No warranty.
40-
5. No modifications permitted.
69+
5. No modifications permitted.

0 commit comments

Comments
 (0)