Skip to content

Commit

Permalink
Add contributors info
Browse files Browse the repository at this point in the history
  • Loading branch information
mmvanheusden committed Jul 8, 2022
1 parent 1a3e6d7 commit d906765
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ There is a video tutorial available [here](https://www.youtube.com/watch?v=dQw4w

## Contributing

If you want to contribute to SteamDepotDownloaderGUI, please make sure to follow
the [contributing instructions and guidelines](contributing.md).

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to keep code consistent and cross-platform compatible.
Expand Down
61 changes: 61 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# SteamDepotDownloaderGUI development information

SteamDepotDownloaderGUI is a graphical user interface for DepotDownloader.

It is written in Node.js and uses the [electron](https://electronjs.org/) framework.
The CSS framework is [Primer](https://primer.style).

## Setup development environment

**Note that these instructions may differ from operating system to operating system.**

* Install node.js, npm, and git on your computer.

* Clone the repository.

```bash
git clone https://github.com/mmvanheusden/SteamDepotDownloaderGUI
```

* Move into the directory and install npm dependencies.

```bash
cd SteamDepotDownloaderGUI
npm install
```

* **You are now ready to contribute**

## Testing the application

```bash
npm start
```

## Building the application

```bash
npm run build
```

* If you are using macOS, you may build using the following command:

```bash
npm run buildall
```

This will build the application for all supported operating systems.

## Contributing Guidelines

Please make sure to keep code consistent and cross-platform compatible.

After you made a change, clean-up the code using your favorite code editor and run the following command:

```bash
npx eslint *.js --fix
```

Please make sure your git commit message is descriptive and contains the changes you made.

**Happy coding!**

0 comments on commit d906765

Please sign in to comment.