Skip to content

Commit

Permalink
docs: troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
freelerobot authored Oct 10, 2023
1 parent 1ec3d31 commit 7c2815c
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,20 @@ In the background, Jan runs [Nitro](https://nitro.jan.ai), an open source, C++ i

> See the open source Nitro codebase at https://nitro.jan.ai.
## Troubleshooting
As Jan is development mode, you might get stuck on a broken build.

To reset your installation:

1. Delete Jan Application from /Applications

1. Clear cache:
`rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron`
OR
`rm -rf /Users/$(whoami)/Library/Application\ Support/jan`

---

## Contributing

Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file
Expand All @@ -74,17 +88,15 @@ Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) fi
- node >= 20.0.0
- yarn >= 1.22.0

### Use as complete suite (in progress)

### For interactive development
### Instructions

Note: This instruction is tested on MacOS only.

1. **Clone the Repository:**

```
git clone https://github.com/janhq/jan
git checkout feature/hackathon-refactor-jan-into-electron-app
git checkout DESIRED_BRANCH
cd jan
```

Expand Down

0 comments on commit 7c2815c

Please sign in to comment.