MousePaw Media Development Documentation

About the Development Docs

Development at MousePaw Media takes place on a carefully designed technology stack, engineered for efficiency and ease-of-use. To ensure that all developers are familiar with these technologies and methodologies, we maintain this documentation.

Our Development Documentation is not a replacement for any official documentation. Our focus here is to describe our particular instances and usages of our stack’s technologies.

Guides

• Guide: Contributor Introduction (Start Here!)
• Guide: Development Environment
• Guide: Building Code
• Guide: Code Contributions
• Guide: Reviewing Code
• Guide: Live Collaboration
• Guide: Staff Introduction

Development Tools

• Git
  • Installing Git
  • Configuring Git
  • Import Repositories
• C++ and C Development Environment
  • Install the Compiler
  • Install Development Tools
  • Choosing an IDE
• Python3 Development Environment
  • Installing Python
  • Choosing an IDE
• Sphinx Development Environment
  • Installing Python
  • Installing Sphinx
  • Choosing an Editor
  • Writing and Editing Documentation
  • Setting Up Documentation
  • Learning ReStructuredText
• General Development Tools
  • Dia
  • Meld
  • Pencil
  • SpeedCrunch
• Docker
  • Installing Docker Engine
  • Docker Registry Login

IDEs and Editors

We officially support four major code editors for our projects. Each language setup tutorial will independently discuss these options.

If you can’t decide on one, try Visual Studio Code!

• Geany
  • Installing
  • Adding Themes to Geany
• Visual Studio Code
  • Installing
  • Using with Windows and WSL
  • Extensions
  • Connect to GitLab
  • Settings

Design Tools

We use a number of additional tools for our graphics design and audio/video work.

• Graphics Design Tools
  • Birdfont (v2.28 or later)
  • Blender (v2.82 or later)
  • Darktable (v3.0 or later)
  • GIMP (v2.10 or later)
  • Gpick (v0.2.6 or later)
  • Inkscape (v0.92 or later)
  • Krita (v4.2 or later)
  • MyPaint (v2.0 or later)
  • Scribus (v1.5 or later)
• Audio/Video Tools
  • Codecs
  • Audacity (v2.3 or later)
  • Handbrake (v1.3 or later)
  • Kdenlive (v19.12 or later)
  • MuseScore (v3.2 or later)
  • Optional Software
  • Audio Recorder (v3.1 or later)
• Fonts
  • Installing the Font Bundle
  • Installing Individual Fonts
  • About The Fonts
  • Finding More Fonts
• Wacom Tablets
  • Installing Wacom Scripts
  • Using Wacom Scripts

Ubuntu Installation

• Ubuntu Setup: About Linux
  • About the Linux Operating System
  • What Is Free and Open Source?
  • Frequently Asked Questions
• Ubuntu Setup: Installing
  • Making Some Decisions
  • Preparing for Installation
  • Installing Linux
• Ubuntu Setup: Configuring
  • Intro to Ubuntu
  • Updating System
  • Installing Essential Packages
  • Security Stuff
  • Office Applications
  • Web Browser
  • DVD Playback
  • Helpful Settings

Other

• MousePaw Media Administration Guide
  • Table of Contents
• Server Configuration
  • Server Config Index
  • Credits

Indices and tables

• Glossary

• Index

• Search Page

Feedback

This documentation is written and maintained by the MousePaw Media Standards Board. Feedback is welcome via email (developers@mousepawmedia.com).

You can also find us on on the #mousepawmedia channel on Libera.Chat IRC, which is bridged to our company Mattermost chat via the mousepawmedia bot account. (We’re there, promise!)

Pull requests to this repository are not accepted. If you wish to propose a change, email your patch to us at the address above.

For more information about contributing to MousePaw Media projects, see mousepawmedia.com/developers.