ruby2d

Bienvenue à Ruby 2d!

Ceci est le Ruby 2D Gem. Consultez le site Web Ruby 2D pour apprendre à commencer à créer des applications 2D dans Ruby.

Développement

Pour travailler sur la gemme localement, clonez d'abord ce dépôt en utilisant:

git clone --recursive https://github.com/ruby2d/ruby2d.git

Pour maintenir la taille de ce référentiel de code source petit, les sous-modules GIT sont utilisés pour référencer les actifs. L'indicateur --recursive garantit que les sous-modules sont initialisés et mis à jour lorsque ce référentiel est cloné. Si vous avérez cloner ce dépôt sans le drapeau --recursive , vous pouvez toujours initialiser et mettre à jour les sous-modules avec:

git submodule init
git submodule update --remote

Mettez à jour ces sous-modules à tout moment à l'aide git submodule update --remote ou de la tâche rake update .

Ensuite, installez les dépendances avec Bundler en exécutant bundle install pour obtenir les gemmes de développement.

Enfin, exécutez rake pour construire et installer la gemme localement. Utilisez rake dev pour créer des bibliothèques référencées sur l'utilisateur (par exemple SDL).

Tests

Ruby 2D utilise une combinaison de tests automatisés via RSPEC et des tests interactifs manuels pour vérifier l'exactitude des fonctionnalités visuelles, audio et d'entrée. Construisez la gemme et exécutez tous les tests automatisés à l'aide de la commande rake . Créez et exécutez un test interactif dans le test/ répertoire à l'aide rake test:<target> <name_of_test> , par exemple:

 # Run `test/testcard.rb` using the standard Ruby interpreter, MRI (CRuby)
rake test:cruby testcard  # `test:mri` or just `test` work also

# Build `test/audio.rb` using mruby and run
rake test:mruby audio

# Build `test/mouse.rb` for the web using WebAssembly and run in the default browser
rake test:wasm mouse

Contribuer

Ruby 2D est un projet entièrement open source (y compris ses dépendances) construit par des gens dédiés qui croient que la création d'applications 2D devrait être simple, naturelle et joyeuse, dans l'esprit de la langue Ruby elle-même.

Si vous souhaitez vous impliquer, il existe plusieurs façons de le faire:

• Suggérer et implémenter de nouvelles fonctionnalités. ? Ruby 2D fait déjà beaucoup, mais il y a beaucoup de nouvelles choses qu'il pourrait faire. Si vous avez une demande de fonctionnalité ou une suggestion sur la façon d'améliorer la langue spécifique au domaine, ou quelque chose d'autre à ajouter, supprimer ou modifier, ouvrir un nouveau problème et nous en parler. Si vous voulez simplement parler avec désinvolture une idée sans la pression d'ouvrir un problème, envoyez une note à la liste de diffusion ou discutez avec nous sur Gitter.

• Ajoutez une prise en charge de plus de plates-formes. Ruby 2D vise à être entièrement transformable. Aidez-nous à tester et à améliorer l'expérience du développeur sur les plates-formes existantes et à en ajouter de nouvelles.

• Trouver et résoudre les problèmes. ? Votre aide à l'identification et à la correction des bogues et à l'amélioration des performances en cours de route sera essentielle pour que les autres aient une solide expérience en utilisant la bibliothèque. Découvrez le tracker du problème et avez-vous!

• Rédiger et revoir la documentation. La documentation est d'une importance vitale pour le succès de chaque projet open source. Nous partons décents, mais il y a toujours plus à écrire et à éditer. Parcourez le site Web de Ruby 2D et aidez-nous à identifier les domaines pour ajouter de la clarté ou combler les lacunes. En haut de la plupart des pages, vous verrez un lien pour "suggérer une modification" qui va directement au fichier source dans le site Web du site Web.

• Créer et améliorer des exemples. ? Nous sommes actuellement un peu légers sur des applications d'échantillons pour aider les gens à démarrer. Nous aimerions obtenir vos idées de petites applications à un seul fichier pour guider les utilisateurs à travers des fonctionnalités ou des techniques spécifiques, que nous collectons dans le référentiel d'exemples. Découvrez la vitrine pour voir ce que les gens construisent et inspirez-vous.

Contributions techniques

Afin de parvenir à une telle simplicité, beaucoup doit se produire sous le capot. Que ce soit l'ajout d'une fonctionnalité ou la correction d'un bogue, essayez de procéder ce qui suit pour vous assurer que votre demande de traction est fusionnée. Certains d'entre eux peuvent sembler intimidants, mais nous sommes heureux de vous aider en cours de route!

• Vérifiez s'il y a un problème existant, et sinon, ouvrez un nouveau pour commencer une discussion. Avant de consacrer du temps et de l'énergie à une idée ou à une correction, assurez-vous qu'elle est cohérente avec les principes et les objectifs du projet, et que nous avons une stratégie solide en place pour mettre en œuvre et tester.

• Utilisez un sous-ensemble de rubis qui fonctionne partout. Les applications Ruby 2D sont, bien sûr, écrites en Ruby. Certains utilisateurs peuvent choisir d'exploiter toute la puissance de la langue, de la bibliothèque standard et de l'écosystème des gemmes en écrivant des applications interprétées ciblant l'implémentation standard, IRM. D'autres peuvent vouloir cibler le Web via WebAssembly, des appareils mobiles ou créer des applications de bureau natives, tous qui utilisent une implémentation Ruby différente appelée MruBy. Ruby 2D vise à prendre en charge tous ces cas d'utilisation, même avec la même base de code d'application. Votre contribution doit supporter un sous-ensemble de rubis qui est compatible avec et se comporte de la même manière entre l'IRM / CRUBY et MruBy. Au-delà de la lecture de la documentation pour chaque implémentation Ruby, vous pouvez également essayer des extraits de code sur la ligne de commande en utilisant leurs réponses respectives: irb pour l'IRM et mirb pour Mruby.

• Testez de manière exhaustive votre changement. Contrairement à d'autres bibliothèques Ruby, tout ici ne peut pas être facilement recouvert de tests unitaires seuls. Nous devons également nous assurer que les choses sont correctes et sonnent, les entrées fonctionnent comme prévu et que le comportement est cohérent sur toutes les plateformes de supports Ruby 2D.

Mise à jour de Ruby 2D

1. Mettez à jour le dépôt d'actifs, suivez les instructions dans le Readme
2. Exécutez rake update pour mettre à jour les sous-modules

Préparer une libération

1. Exécutez des tests sur toutes les plateformes prises en charge
2. Mettez à jour le numéro de version dans version.rb , commettez des modifications
3. Créez une nouvelle version dans GitHub, avec Tag dans la forme v#.#.# , Et écrivez une petite note de version
4. Exécutez rake release pour construire le gemme, puis le pousser sur rubygems.org avec gem push ruby2d-#.#.#.gem
5. ?