Skip to content

Commit fea273e

Browse files
authored
Merge pull request #41 from gitbito/release-3.6
Readme changes for release 3.6
2 parents 7181c3f + ded5c9f commit fea273e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,21 @@ run ```bito --help``` or ```bito config --help```
115115

116116
- run ```echo "give me code for bubble sort in python" | bito``` to instantly get response for your queries using Bito CLI.
117117

118+
#### More on Bito CLI MyPrompt:
119+
120+
##### Using Comments:
121+
122+
Anything after ```#``` in your prompt file will be considered as a comment by Bito CLI and won't be part of your prompt.
123+
124+
You can use ```\#``` as an escape sequence to make ```#``` as a part of your prompt and to not use it for commenting anymore.
125+
126+
###### Few examples for above:
127+
128+
1. Give me an example of bubble sort in python # everything written here will be considered as a comment now.
129+
2. Explain what this part of the code do: ```\#include<stdio.h>```
130+
i. in the example above ```\#``` can be used as an escape sequence to include ```#``` as a part of your prompt.
131+
3. #This will be considered as a comment as it contains # at the start of the line itself.
132+
118133
##### Using Macro:
119134

120135
Use ``{{%input%}}`` macro in the prompt file to refer to the contents of the file provided via -f option
@@ -188,6 +203,19 @@ Such persisted Access Key can be over-ridden by running ```bito -k <access-key>`
188203
1. Unicode characters (using other languages) might not be readily supported on command prompt if you are on Windows 10 or below. You can run command ```chcp 936``` in cmd prior to using bito to support unicode characters in Windows 10 or below (To undo the settings done here you can follow this [link](https://share.bito.co/static/share?aid=8e535e57-d57f-4e03-a692-cf81a98fa6d2)).
189204
2. IF you are on Windows 11 then you shouldn't encounter any such issues.
190205

206+
### Using Homebrew for Bito CLI:
207+
1. Before using homebrew, please make sure that you uninstall any previously installed versions of Bito CLI using the uninstall script provided [here](https://github.com/gitbito/CLI#uninstalling-bito-cli).
208+
2. Once above is done then you can use following commands to install Bito CLI using homebrew:
209+
- First tap the CLI repo using ```brew tap gitbito/bitocli```, this should be a one time action and not required every time.
210+
- Now you can install Bito CLI using following command:
211+
- ```brew install bito-cli``` - this should install Bito CLI based upon your machine architecture.
212+
- To update Bito CLI to the latest version, use following commands:
213+
- Please make sure you always do ```brew update``` before upgrading to avoid any errors.
214+
- ```brew update``` - this will update all the required packages before upgrading.
215+
- ```brew upgrade bito-cli``` - once above is done, this will update Bito CLI to the latest version.
216+
- To uninstall Bito CLI you can either use the uninstall command from [here](https://github.com/gitbito/CLI#uninstalling-bito-cli) or use following commands:
217+
- ```brew uninstall bito-cli``` - this should uninstall Bito CLI completely from your system.
218+
191219
## License ##
192220

193221
Copyright (C) 2021, Bito Inc - All Rights Reserved

0 commit comments

Comments
 (0)