diff --git a/README.md b/README.md index a555e8c..737ffa0 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file +# 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 diff --git a/package.json b/package.json index 68af7eb..f1ab934 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ { "name": "@electron-forge/maker-zip", "platforms": [ - "darwin" + "darwin", + "linux" ] }, {