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

[REVIEW] README.md comments. #17

Open
19 of 21 tasks
satyarth934 opened this issue Sep 12, 2021 · 0 comments
Open
19 of 21 tasks

[REVIEW] README.md comments. #17

satyarth934 opened this issue Sep 12, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation review Updates/Comments/Suggestion during a review session.

Comments

@satyarth934
Copy link
Member

satyarth934 commented Sep 12, 2021

Title

  • The title format does not match the other repos like Image Similarity Search or Chrome extension.
  • Check the other repos for formats to include the "Published by" line and the buttons.
  • Move the Colab button here.

Section 1: intro

  • Set title "About the tool" or something similar for this section.
  • Move the first line defining the tool with the later paragraph. Format it to match the other text.
  • Move the colab button to the title section.
  • Highlight the left and right swipe and keyboard keys in the labeling instructions.
  • Ask Ricardo if he has some better ideas for the GIF that can also include the mobile GUI.

Section 2: Usage vs. Development Modes

  • Directly specify the Usage and Development as separate titles. Keep in mind that the reader would want to start using the tool ASAP. So minimize the reading content if it's not mandatory.

Section 2.1 Usage

  • Make this the major title.
  • In step 2, also add the command to move to the project folder.
    cd Swipe-Labeler
  • In step 3, can mention that although optional, it is recommended that the user creates a virtual env.
  • In step 5, replace the command with
    python api/api.py --path_for_unlabeled=path/to/unlabelled_images_dir --batch_size=5
  • Include a directory tree showing a sample directory structure before and after the labeling process.
  • Make sure that the port number 5000 is fixed for every use.

Section 2.2: Setup (for development)

Section 2.2.1: Setting up the web server

  • In step 5, can mention that although optional, it is recommended that the user creates a virtual env.

Section 2.2.3: Usage (for development)

  • In step 2, replace the command with
    python api/api.py --to_be_labeled=path/to/unlabelled_images_dir
  • Put npm run build command in a separate line.

Section 3: FAQs

  • Move the python3 and pip questions as 1 and 2 because they are referred first in the usage section.

Section 4: About the authors

  • Fill this section.

Section 5: Citation

  • Fill the author field.
@satyarth934 satyarth934 added documentation Improvements or additions to documentation review Updates/Comments/Suggestion during a review session. labels Sep 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation review Updates/Comments/Suggestion during a review session.
Projects
None yet
Development

No branches or pull requests

2 participants