Skip to content

Commit

Permalink
Add build instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Raymo111 authored Aug 15, 2023
1 parent bcbf2c8 commit 7da2117
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,25 @@

CharaChorder's all-in-one desktop app, supporting Linux, Windows, and MacOS.

## Build
1. Get Python 3.11 (using [pyenv](https://github.com/pyenv/pyenv) recommended)
2. Clone and build
```
git clone https://github.com/CharaChorder/nexus
cd nexus/
python dist.py
```
Note: the CI-generated binaries (in releases) don't work at the moment (see [#6 CI doesn't work](https://github.com/CharaChorder/nexus/issues/6)).
`dist.py` sets up a virtualenv in the root directory of the repo, and generates a platform-dependent executable in the `dist/` directory.

## Usage
```
cd dist/ # if following the steps above
./nexus # Unix
.\nexus.exe # Windows
```
Use the `-h` to access CLI options.

## Contributing

Please create PRs and issues, we welcome all contributions. See issues tagged with `Help Wanted` for where you can best help.
Expand Down

0 comments on commit 7da2117

Please sign in to comment.