Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #2

wants to merge 2 commits into from

Conversation

AbhishekSrivastava-23
Copy link
Owner

@AbhishekSrivastava-23 AbhishekSrivastava-23 commented Sep 27, 2023

This branch contains the Readme file for the main branch.

README.md Outdated Show resolved Hide resolved
### DATASET GENERATION
- Random Data can be generated by running the file data_generator.py.
- This will write the data in data_entry.tql file.
- Then commit the changes, while in **Session type DATA** and **Transaction type WRITE**.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to provide an example command that the user would run to write these changes to the database.

## HOW TO USE
#### Make sure that you have TypeDB Server installed. (Find instructions [here](https://typedb.com/docs/typedb/2.x/installation)).
1. Get the repository and extract its files.
2. Start the terminal using ```typedb server``` command on Terminal.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're starting the server here, not the terminal.

**Onboarding project to illustrate the connectivity of TypeQL and Python**
## HOW TO USE
#### Make sure that you have TypeDB Server installed. (Find instructions [here](https://typedb.com/docs/typedb/2.x/installation)).
1. Get the repository and extract its files.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which repository? Be specific. It would be very easy for a user to get confused and think you mean this repository rather than the TypeDB repository. Additionally, if you're cloning the entire repo there's no need to extract files. You'd need to extract files when downloading the release archive from the repo.

Co-authored-by: Sam Butcher <samuel@vaticle.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants