Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Update README.md (#1263)

Browse Source 
Updated steps to prepare for contributing
This commit is contained in:
Albert Nguyen 2023-12-31 11:36:16 +07:00 committed by GitHub
parent 26e51fddac
commit 7eeb1c4a39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -146,15 +146,15 @@ Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) fi
### Instructions ### Instructions
1. **Clone the Repository:** 1. **Clone the repository and prepare:**
```bash ```bash
git clone https://github.com/janhq/jan git clone https://github.com/janhq/jan
git checkout DESIRED_BRANCH
cd jan cd jan
git checkout -b DESIRED_BRANCH
``` ```
2. **Run development and Using Jan Desktop** 2. **Run development and use Jan Desktop**
``` ```
make dev make dev
@ -165,10 +165,7 @@ Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) fi
### For production build ### For production build
```bash ```bash
# Do step 1 and 2 in previous section # Do steps 1 and 2 in the previous section
git clone https://github.com/janhq/jan
cd jan
# Build the app # Build the app
make build make build
``` ```
@ -203,7 +200,7 @@ Jan builds on top of other open-source projects:
## Contact ## Contact
- Bugs & requests: file a Github ticket - Bugs & requests: file a GitHub ticket
- For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH) - For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH)
- For business inquiries: email hello@jan.ai - For business inquiries: email hello@jan.ai
- For jobs: please email hr@jan.ai - For jobs: please email hr@jan.ai