Skip to content

Commit

Permalink
Document How to Build for Linux & macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
swiknaba committed Sep 26, 2022
1 parent cdd6712 commit e7a3c1a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 4 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,39 @@
# RDS Manager
Provides a simple way to get password to AWS RDS instances in form of Electron app.

# How to install?
# How to install

```sh
-> yarn install
-> yarn start
```

# How to build? (TODO)
# How to contribute? (TODO)
# How to build

## With an ARM chip ("M1 Mac")

### Build for Mac

```shell
yarn make -p darwin -a x64
yarn make -p darwin -a arm64
```

### Build for Linux

You might need to install some extra packages:
```shell
brew install dpkg
brew install fakeroot
brew install rpm
```

then
```shell
yarn make -p linux -a x64
yarn make -p linux -a arm64
```

# How to contribute
* Open an issue to start a conversation
* Open a pull request
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
{
"name": "@electron-forge/maker-zip",
"platforms": [
"darwin"
"darwin",
"linux"
]
},
{
Expand Down

0 comments on commit e7a3c1a

Please sign in to comment.