Skip to content

Commit

Permalink
chore update readme (#218)
Browse files Browse the repository at this point in the history
Co-authored-by: Hien To <[email protected]>
  • Loading branch information
hiento09 and hiento09 committed Sep 28, 2023
1 parent 918c7e3 commit 7aba085
Show file tree
Hide file tree
Showing 8 changed files with 49 additions and 97 deletions.
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,55 @@ Not supported yet: Apple Intel, Linux RPM, Windows x86|ARM64, AMD ROCm

> See [developer docs](https://docs.jan.ai/docs/) for detailed installation instructions.
## Installation and Usage

### Pre-requisites
- node >= 20.0.0
- yarn >= 1.22.0

### Use as complete suite (in progress)
### For interactive development

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
cd jan
```

2. **Install dependencies:**

```
yarn install
```

4. **Run development and Using Jan Desktop**

```
yarn dev
```
This will start the development server and open the desktop app.
In this step, there are a few notification about installing base plugin, just click `OK` and `Next` to continue.

### For production build

```bash
# Do step 1 and 2 in previous section
git clone https://github.com/janhq/jan
cd jan
yarn install

# Build the app
yarn build
```

This will build the app MacOS m1/m2 for production (with code signing already done) and put the result in `dist` folder.



## Contributing

Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file
Expand All @@ -92,7 +141,6 @@ Jan builds on top of other open-source projects:
- [llama.cpp](https://github.com/ggerganov/llama.cpp)
- [TensorRT](https://github.com/NVIDIA/TensorRT)
- [Keycloak Community](https://github.com/keycloak/keycloak) (Apache-2.0)
- [Hasura Community Edition](https://github.com/hasura/graphql-engine) (Apache-2.0)

## Contact

Expand Down
96 changes: 0 additions & 96 deletions web/README.md

This file was deleted.

Binary file removed web/images/jan-desktop-dev-instruction-1.png
Binary file not shown.
Binary file removed web/images/jan-desktop-dev-instruction-2.png
Binary file not shown.
Binary file removed web/images/jan-desktop-dev-instruction-3.png
Binary file not shown.
Binary file removed web/images/jan-desktop-dev-instruction-4.png
Binary file not shown.
Binary file removed web/images/jan-desktop-dev-instruction-5.png
Binary file not shown.
Binary file removed web/images/jan-desktop-dev-instruction-6.png
Binary file not shown.

0 comments on commit 7aba085

Please sign in to comment.