mirrors/tabby
1
0
Fork 0
mirror of https://github.com/TabbyML/tabby synced 2024-11-22 17:41:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add contributing section and build instructions (#405)

Browse Source 
* docs: add contributing section and build instructions

* fix

* Update README.md
This commit is contained in:
Meng Zhang 2023-09-06 21:04:35 +08:00 committed by GitHub
parent 9a59bf3340
commit f3c03e903a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -28,7 +28,7 @@ Tabby is a self-hosted AI coding assistant, offering an open-source and on-premi
* **08/24/2023** Tabby is now on [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/22379-tabby)!
## 👋 Get Started
## 👋 Getting Started
The easiest way to start a Tabby server is by using the following Docker command:
@ -40,6 +40,31 @@ docker run -it \
```
For additional options (e.g inference type, parallelism), please refer to the documentation at https://tabbyml.github.io/tabby.
## 🤝 Contributing
### Get the Code
```bash
git clone --recurse https://github.com/TabbyML/tabby
cd tabby
```
### Build
1. Set up the Rust environment by following this [tutorial](https://www.rust-lang.org/learn/get-started).
2. Install the required dependencies:
```bash
# For MacOS
brew install protobuf
# For Ubuntu / Debian
apt-get install protobuf-compiler libopenblas-dev
```
3. Now, you can build Tabby by running the command `cargo build`.
## 🌟 Star History
[![Star History Chart](https://api.star-history.com/svg?repos=tabbyml/tabby&type=Date)](https://star-history.com/#tabbyml/tabby&Date)