Revise setup instructions and directory structure#92
Open
georgemgichuru wants to merge 1 commit into
Open
Conversation
Updated the setup documentation to reflect changes in the directory structure and installation instructions. Signed-off-by: George Mwangi Gichuru <georgem.gichuru@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the developer setup guide to reflect the repository’s current directory structure and where dependency-install scripts live.
Changes:
- Document
docs/anddatasets/in the repository tree. - Update the setup instructions around dependency installation scripts and related paths/formatting.
- Minor formatting cleanup in the document footer.
Comments suppressed due to low confidence (1)
docs/SETUP.md:53
- The commands here run
install-deps.shwithout a path, but the script now lives underscripts/install-deps.sh. As written, users following from the repo root will get “file not found” unless they manuallycd scriptsfirst (which isn't shown). Update the instructions to either include an explicitcd scriptsstep or call the script via./scripts/install-deps.sh(and chmod the same path).
First navigate to the scripts folder
Run the provided script to install all core libraries:
```bash
chmod +x install-deps.sh
./install-deps.sh
| ├── docker-compose.yaml | ||
| ├── install-deps.sh | ||
| ├── .vscode/ # Contains IntelliSense config | ||
| ├── scripts # Contains the scripts to install the core libraries |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the project documentation to reflect recent changes in the project structure and dependency installation process. The main focus is on clarifying the location of scripts and new directories in the repository.
Documentation updates:
docs/SETUP.mdto include the newdocs/anddatasets/directories, and replacedinstall-deps.shwith ascriptsdirectory for core library installation scripts.docs/SETUP.mdthat users should first navigate to thescriptsfolder before running the dependency installation script.