mirror of
https://github.com/tildearrow/furnace.git
synced 2024-11-30 00:13:03 +00:00
make furnace discord server
sure
This commit is contained in:
parent
f0eca1bea2
commit
e443e71a20
2 changed files with 60 additions and 2 deletions
52
CONTRIBUTING.md
Normal file
52
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,52 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
contributions to Furnace are welcome!
|
||||||
|
|
||||||
|
# Getting ready
|
||||||
|
|
||||||
|
log into your Github account, and click the Fork button in the header of the project's page.
|
||||||
|
|
||||||
|
then open a terminal and clone your fork:
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone git@github.com:USERNAME/furnace.git
|
||||||
|
```
|
||||||
|
|
||||||
|
(replace `USERNAME` with your username)
|
||||||
|
|
||||||
|
# Working
|
||||||
|
|
||||||
|
## Code
|
||||||
|
|
||||||
|
bug fixes, improvements and several other things accepted.
|
||||||
|
|
||||||
|
the coding style is described here:
|
||||||
|
|
||||||
|
- indentation: two spaces
|
||||||
|
- modified 1TBS style:
|
||||||
|
- no spaces in function calls
|
||||||
|
- spaces between arguments in function declarations
|
||||||
|
- no spaces in operations except for `||` and `&&`
|
||||||
|
- no space between variable name and assignment
|
||||||
|
- space between macro in string literals
|
||||||
|
- C++ pointer style: `void* variable` rather than `void *variable`
|
||||||
|
- indent switch cases
|
||||||
|
- preprocessor directives not intended
|
||||||
|
- if macro comprises more than one line, indent
|
||||||
|
|
||||||
|
some files (particularly the ones in `src/engine/platform/sound` and `extern/`) don't follow this style.
|
||||||
|
|
||||||
|
you don't have to follow this style. I will fix it after I accept your contribution.
|
||||||
|
|
||||||
|
## Demo Songs
|
||||||
|
|
||||||
|
just put your demo song in `demos/`!
|
||||||
|
|
||||||
|
# Finishing
|
||||||
|
|
||||||
|
after you've done your modifications, commit the changes and push.
|
||||||
|
then open your fork on GitHub and send a pull request.
|
||||||
|
|
||||||
|
# I don't know how to use Git but I want to contribute with a demo song
|
||||||
|
|
||||||
|
you can also contact me directly! [find me here.](https://tildearrow.org/?p=contact)
|
10
README.md
10
README.md
|
@ -4,6 +4,8 @@
|
||||||
|
|
||||||
this is a work-in-progress chiptune tracker compatible with DefleMask modules (.dmf).
|
this is a work-in-progress chiptune tracker compatible with DefleMask modules (.dmf).
|
||||||
|
|
||||||
|
[downloads](#downloads) | [discussion](#discussion) | [help](#help) | [developer info](#developer-info)
|
||||||
|
|
||||||
## features
|
## features
|
||||||
|
|
||||||
- supports the following systems:
|
- supports the following systems:
|
||||||
|
@ -36,7 +38,11 @@ this is a work-in-progress chiptune tracker compatible with DefleMask modules (.
|
||||||
|
|
||||||
## downloads
|
## downloads
|
||||||
|
|
||||||
check out the Releases page. available for Windows, macOS and Linux (AppImage).
|
check out the [Releases](https://github.com/tildearrow/furnace/releases) page. available for Windows, macOS and Linux (AppImage).
|
||||||
|
|
||||||
|
## discussion
|
||||||
|
|
||||||
|
see the [Discussions](https://github.com/tildearrow/furnace/discussions) section, or (preferably) the [official Discord server](https://discord.gg/EfrwT2wq7z).
|
||||||
|
|
||||||
## help
|
## help
|
||||||
|
|
||||||
|
@ -59,7 +65,7 @@ your typical CMake project. clone (including submodules) and:
|
||||||
|
|
||||||
### Windows using MSVC
|
### Windows using MSVC
|
||||||
|
|
||||||
**no longer tested!** as of now tildearrow uses MinGW for Windows builds...
|
as of now tildearrow uses MinGW for Windows builds, but thanks to OPNA2608 this works again!
|
||||||
|
|
||||||
from the developer tools command prompt:
|
from the developer tools command prompt:
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue