From 7729cc27ab373d9107a38470322d0ef86dece66b Mon Sep 17 00:00:00 2001 From: vimal-m <61645553+vimal-m@users.noreply.github.com> Date: Thu, 14 Oct 2021 11:59:32 +0530 Subject: [PATCH] Updated Readme.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d3d1968..7b240a5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ # Acharya -Acharya Machine Teaching Platform +A Data Centric MLOps tool for your Named Entity Recognition projects. # Download Download the acharya binary latest release for your system. # Initial Run and Setup Installation and Setup for Acharya is not required, Acharya detects it running for the first time and runs the initial setup when run for the first time. -To start Acharya type the following command +To start Acharya type the following command in a terminal/command prompt +It is recommended to create a separate folder to run acharya. Acharya will create a data folder and a temp folder to store its data. On *sh shells ```bash +#copy the downloaded file to the newly created acharya folder and run the following commands. +chmod +x acharya ./acharya ``` @@ -18,7 +21,13 @@ On Powershell and COMMAND in Windows acharya.exe ``` -Follow the on screen instructions to configure the SSL certificates required for encryption. +Acharya will generate a password for the default user admin@localhost + +The UI will be accessible at http://localhost:3000 + +Login to the UI with admin@localhost as the username and the password displayed on the terminal/command prompt screen. + +It is recommended that the users change this password from the UI # Using Acharya Login to the Acharya UI using a web-browser and access the URL seen in the output of the above command. The default URL would be https://localhost:3000