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

docs: troubleshooting

Browse Source
This commit is contained in:
0xSage 2023-10-10 02:03:48 +00:00 committed by GitHub
parent 1ec3d3183f
commit 7c2815c0b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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. > 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 ## Contributing
Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file
@ -74,9 +88,7 @@ Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) fi
- node >= 20.0.0 - node >= 20.0.0
- yarn >= 1.22.0 - yarn >= 1.22.0
### Use as complete suite (in progress) ### Instructions
### For interactive development
Note: This instruction is tested on MacOS only. Note: This instruction is tested on MacOS only.
@ -84,7 +96,7 @@ Note: This instruction is tested on MacOS only.
``` ```
git clone https://github.com/janhq/jan git clone https://github.com/janhq/jan
git checkout feature/hackathon-refactor-jan-into-electron-app git checkout DESIRED_BRANCH
cd jan cd jan
``` ```