Skip to content

Update README file to include documentation links #62

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Update README file to include documentation links #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Annotate-Lab is an open-source application designed for image annotation, compri
- [Contributing](#contributing)
- [License](#license)

## Project Structure
## Project Structure [[documentation page]](https://annotate-docs.dwaste.live/overview/project-structure)
```sh

annotation-lab/
Expand Down Expand Up @@ -68,7 +68,7 @@ annotation-lab/
- **app.py**: Main Flask application file.
- **requirements.txt**: Contains server dependencies.

## Settings
## Settings [[documentation page]](https://annotate-docs.dwaste.live/fundamentals/set-up-and-run/configuration)
One can configure the tools, tags, upload images and do many more from the settings.

![configuration](./sample_images/configuration.png)
Expand All @@ -85,7 +85,7 @@ One can configure the tools, tags, upload images and do many more from the setti
- pandas
- Other dependencies as listed in `requirements.txt`

## Setup and Installation
## Setup and Installation [[documentation page]](https://annotate-docs.dwaste.live/fundamentals/set-up-and-run)

### Client Setup
1. Navigate to the `client` directory:
Expand Down Expand Up @@ -195,7 +195,7 @@ This command discovers and runs all test files (`test_*.py`) in the `server/test
2. Use the user interface to upload and annotate images.
3. The annotations and other interactions will be handled by the Flask server running at [http://localhost:5000](http://localhost:5000).

## Configurations (Optional)
## Configurations (Optional) [[documentation page]](https://annotate-docs.dwaste.live/overview/customization)
You can customize various aspects of Annotate-Lab through configuration settings. To do this, modify the `config.py` file in the `server` directory or the `config.js` file in the `client` directory.
```python
# config.py
Expand Down Expand Up @@ -314,7 +314,7 @@ Sample of annotated image along with its mask and settings is show below.

```

## Troubleshooting
## Troubleshooting [[documentation page]](https://annotate-docs.dwaste.live/troubleshooting)

- Ensure that both the client and server are running.
- Check the browser console and terminal for any errors and troubleshoot accordingly.
Expand Down
Loading