How can I add README.md to my UiPath project?

I want to save my UiPath project to Github.com.
Is it possible to add/edit README.md file (or other files) from within Studio?
Thanks

Hi @AndrewGuo,

Welcome to community.

@RAKESH_KUMAR_BEHERA explained it well. You can follow the video.

Regards,
MY

@AndrewGuo Is that mean you want to edit the .md file which is present in the GitHub using UiPath directly. If that is the case I guess its not possible at the moment. Every time you make changes to the code you should commit(save) to GitHub. Hope this helps!!

@muhammedyuzuak Thanks for your information. I can save my project into Github but want to add some documents(readme, instruction, notes, etc) into the project folder.

@ushu Thanks, hope we can get this feature in the future.

This video doesn’t show how to add a readme file via UiPath Studio.

  1. Open the file explorer or terminal and navigate to your Git project directory.
  2. Create a new README.md file in the project directory using any text editor or command-line tool. Add the desired content to the README.md file, such as project description or instructions.
  3. Open a terminal or command prompt and navigate to your Git project directory.
  4. Use the following Git commands to stage, commit, and push the changes:
    # Stage the README.md file
  •      git add README.md*
    
  •      *
    
  •      # Commit the changes*
    
  •      git commit -m "Add README.md file"*
    
  •      *
    
  •      # Push the changes to the remote repository*
    
  •      git push*
    

Step two can be directly done in Studio as well.

Thanks for the prompt reply. I’ve got the readme file in my project and already integrated my project with Git.

How do I see the readme file in UI path studio and edit it via UI path studio?

Screenshot 2023-07-14 at 12.11.42 pm

Click on Filter under Project and select the Other option as well. Hope it helps.

image

1 Like

Thank you so much. Yes, it resolved my queries.

Clicking Open in Text Editor opens a file in the UiPath studio. BINGO.
Screenshot 2023-07-14 at 1.48.45 pm

Happy to help. Regards… :slightly_smiling_face:

1 Like