Contributing guide

Also updated IPA generation script

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at inds@nerd.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing Guide
+Contributions are always welcome, no matter how big or small. Like most sane projects,
+we strive for forwards compatibility, however, if changes are
+merited, they will be made. Before contributing, please read the [code of conduct.](CODE_OF_CONDUCT.md)
+
+## Questions
+If you have a question that does not appear to be an issue with the repository
+(e.g. not sure how to set up or use). Please reach out our Gitter chatroom.
+You can always find it in the README as the [![Join the chat at https://gitter.im/iNDS-Team/iNDS](https://badges.gitter.im/iNDS-Team/iNDS.svg)](https://gitter.im/iNDS-Team/iNDS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) button.
+
+## Pull Requests
+Pull requests are always welcomed. Before submitting a pull request, however,
+please make sure you have done the following things:
+1. Fork the repo and create your branch from `master`
+2. If you've added code that should be tested, add tests
+3. If you've changed APIs, try to write documentation.
+5. Write a complete pull request description documenting the changes you've made,
+API changes, etc.

README.md

@@ -1,42 +1,53 @@
-iNDS
-=======
+# iNDS
+
 ###### Supports iOS 9.0 and up.
+
 [![Version](https://img.shields.io/github/release/iNDS-Team/iNDS.svg)](https://github.com/iNDS-Team/iNDS/releases/latest)
 [![Build Status](https://travis-ci.com/iNDS-Team/iNDS.svg?branch=master)](https://travis-ci.com/iNDS-Team/iNDS)
 [![Join the chat at https://gitter.im/iNDS-Team/iNDS](https://badges.gitter.im/iNDS-Team/iNDS.svg)](https://gitter.im/iNDS-Team/iNDS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[iNDS](https://inds.nerd.net) is a derivation of the previous Nintendo DS apps for iOS, nds4ios and [Nitrogen](https://github.com/NitrogenEmulator). 
+[iNDS](https://inds.nerd.net) is a derivation of the previous Nintendo DS apps
+for iOS, nds4ios and [Nitrogen](https://github.com/NitrogenEmulator). The iNDS
+Team release of iNDS is a fork of the original [iNDS emulator by William Cobb](https://github.com/WilliamLCobb/iNDS). iNDS Team aims to create
+a version that is driven by support from the community, adding trusted contributors
+to the team over time, so that pull requests and issues do not sit untouched.
 
-Currently, emulation is powered by the [DeSmuME](http://desmume.org/) threaded ARM interpreter and runs at nearly full speed on the iPhone 5 and above.
+Currently, emulation is powered by the [DeSmuME](http://desmume.org/) threaded ARM interpreter and runs at nearly full speed on the iPhone 5 and above. Due to the need to mmap the entire ROM into memory, older devices with only 256MB of RAM are not supported. These devices include the iPod touch 4, iPad 1, iPhone 3GS, and anything below those devices.
 
-Due to the need to mmap the entire ROM into memory, older devices with only 256MB of RAM are not supported. These devices include the iPod touch 4, iPad 1, iPhone 3GS, and anything below those devices.
+## Installing iNDS
 
-Installing iNDS
-------------------------
 All Instructions on building and installing iNDS can be found [here](https://github.com/iNDS-Team/iNDS/wiki)
 
-Reporting Bugs
-------------------------
+## Contributing
+Feel free to submit issues or pull requests to the repository. Before contributing,
+please read our [Contributing Guide](CONTRIBUTING.md).
+
+## Reporting Bugs
+
 #### When something in iNDS isn't working correctly for you, please [open a GitHub issue ticket here](https://github.com/iNDS-Team/iNDS/issues/new/choose).
+
 ##### Please include the following information:
-* iOS device
-* iOS version
-* Jailbreak status
-* Download location
-* Current iNDS Version
+
+- iOS device
+- iOS version
+- Jailbreak status
+- Download location
+- Current iNDS Version
 
 ##### Please do not open issues about the following topics:
-* Slow performance
-* Crashing on older devices with 256MB of RAM (Anything prior to iPhone 4 devices.)
+
+- Slow performance
+- Crashing on older devices with 256MB of RAM (Anything prior to iPhone 4 devices.)
 
 ##### Your issue ticket will be closed if you fail to follow the above instructions.
 
-To-do
-------------------------
+## To-do
+
 ###### Planned improvments
-* Internal Resolution changes
-* GNU Lightning JIT (JAILBROKEN DEVICES ONLY)
-* Sharing roms between devices
-* Sharable game hacks
-* Add more localizations
-* Much more
+
+- Internal Resolution changes
+- GNU Lightning JIT (JAILBROKEN DEVICES ONLY)
+- Sharing roms between devices
+- Sharable game hacks
+- Add more localizations
+- Much more

genipa.sh

@@ -1,9 +1,13 @@
 OUTDIR=./dist/out.xcarchive
 ORIG=$(pwd)
 xcodebuild -workspace iNDS.xcworkspace -scheme iNDS archive CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY="" -archivePath "$OUTDIR" | xcpretty
-cd "$OUTDIR/Products"
-mv "Applications" "Payload"
-zip -r "iNDS.ipa" "Payload"
-cp "iNDS.ipa" ../../
-cd $ORIG
-echo "\nThe unsigned IPA can be found at dist/iNDS.ipa"
+if [ ${PIPESTATUS[0]} -eq 0 ]; then
+    cd "$OUTDIR/Products"
+    mv "Applications" "Payload"
+    zip -r "iNDS.ipa" "Payload"
+    cp "iNDS.ipa" ../../
+    cd $ORIG
+    echo "\nThe unsigned IPA can be found at dist/iNDS.ipa"
+else
+    echo "\nBuild failed!"
+fi