67 lines
10 KiB
HTML
67 lines
10 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="generator" content="Docusaurus">
|
|
<link rel="preconnect" href="https://www.google-analytics.com">
|
|
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-145065218-1","auto"),ga("send","pageview")</script>
|
|
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
|
|
|
<title data-react-helmet="true">README | NodeGui</title>
|
|
|
|
<meta data-react-helmet="true" http-equiv="x-ua-compatible" content="ie=edge"><meta data-react-helmet="true" property="og:title" content="NodeGui"><meta data-react-helmet="true" name="twitter:card" content="summary"><meta data-react-helmet="true" name="description" content="# Contributor's guide"><meta data-react-helmet="true" property="og:description" content="# Contributor's guide"><meta data-react-helmet="true" property="og:url" content="https://nodegui.org/docs/development/README">
|
|
|
|
<link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico">
|
|
|
|
|
|
<link rel="stylesheet" href="/styles.5d0c291d.css">
|
|
|
|
|
|
<link rel="preload" href="/styles.edba8c47.js" as="script">
|
|
|
|
<link rel="preload" href="/runtime~main.f5db0c57.js" as="script">
|
|
|
|
<link rel="preload" href="/main.2fc10cac.js" as="script">
|
|
|
|
<link rel="preload" href="/1.573cf647.js" as="script">
|
|
|
|
<link rel="preload" href="/2.a570b951.js" as="script">
|
|
|
|
<link rel="preload" href="/1be78505.4cd4b2aa.js" as="script">
|
|
|
|
<link rel="preload" href="/20ac7829.f8770b76.js" as="script">
|
|
|
|
<link rel="preload" href="/17896441.b3b4e664.js" as="script">
|
|
|
|
<link rel="preload" href="/1490091d.6b6226b4.js" as="script">
|
|
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=window.matchMedia("(prefers-color-scheme: dark)"),n=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==n?t(n):e.matches&&t("dark")}()</script>
|
|
<div id="__docusaurus">
|
|
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/logo-circle.png" alt="NodeGui Logo"><strong class="navbar__title">NodeGui</strong></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/docs/guides/getting-started">Docs</a><a class="navbar__item navbar__link" href="/docs/api/manual/synopsis">API</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" target="_blank" rel="noopener noreferrer" href="https://github.com/nodegui/nodegui">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/logo-circle.png" alt="NodeGui Logo"><strong class="navbar__title">NodeGui</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/guides/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/manual/synopsis">API</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a class="menu__link" target="_blank" rel="noopener noreferrer" href="https://github.com/nodegui/nodegui">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><main class="docMainContainer_FFX1"><div class="padding-vert--lg"><div class="container"><div class="row"><div class="col docItemCol_2GOA"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">README</h1></header><div class="markdown"><h1><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="contributors-guide"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#contributors-guide" title="Direct link to heading">#</a>Contributor's guide</h1><p>This guide is for everyone who want's to contribute to the development of NodeGui.</p><p>Please make sure you have read the <a aria-current="page" class="active" href="/">User's guides</a> before reading this guide.</p><ul><li><a href="/docs/development/setting-up">Setting up the NodeGui Contributor's Environment</a><ul><li><a href="/docs/development/setting-up#macosx">Setting up macOS</a></li><li><a href="/docs/development/setting-up#windows">Setting up Windows</a></li><li><a href="/docs/development/setting-up#linux">Setting up Linux</a></li></ul></li><li><a href="/docs/development/getting-started">Getting started</a><ul><li><a href="/docs/development/getting-started#Code-Structure">Code Structure</a></li><li><a href="/docs/development/getting-started#Wrapping-a-widget">Wrapping a widget: TLDR version</a></li><li><a href="/docs/development/getting-started#Learning-Materials">Learning Materials</a></li></ul></li><li><a href="/docs/development/styling">Styling</a><ul><li><a href="/docs/development/styling#painting">Painting</a></li><li><a href="/docs/development/styling#layout">Layout</a></li></ul></li><li><a href="/docs/development/signal_and_event_handling">Signal and Event Handling</a></li><li><a href="/docs/development/debugging">Debugging</a></li><li><a href="/docs/development/common_errors">Common Errors</a></li><li><a href="/docs/development/wrapping_widgets">Wrapping a Widget: Detailed</a></li></ul><h1><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="where-to-start-or-how-can-you-help"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#where-to-start-or-how-can-you-help" title="Direct link to heading">#</a>Where to start or How can you help?</h1><p> You can follow the contributors guide above to get a gist.</p><p> It is fairly straightforward to get started. I would start with a project of my own and start adding missing functionalities.</p><p> Or simply put I would recommend you start by adding an unexported method to an existing widget.</p><p> <strong>For example:</strong></p><p> You could add the corresponding Qt method to QProgressbar
|
|
<a href="https://doc.qt.io/qt-5/qprogressbar.html#textVisible-prop">https://doc.qt.io/qt-5/qprogressbar.html#textVisible-prop</a> to get a grip on it.</p><p> This PR can be used as a guide</p><p> <a href="https://github.com/nodegui/nodegui/issues/36">https://github.com/nodegui/nodegui/issues/36</a></p><p> <a href="https://github.com/nodegui/nodegui/pull/39">https://github.com/nodegui/nodegui/pull/39</a></p><p> You can also take a look at few bugs or the issue board here to know what you can pick up if you are out of ideas.</p><p> <a href="https://github.com/nodegui/nodegui/projects/">https://github.com/nodegui/nodegui/projects/</a></p><p> <a href="https://github.com/nodegui/react-nodegui/projects/">https://github.com/nodegui/react-nodegui/projects/</a></p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/nodegui/nodegui/edit/master/website/docs/development/README.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"></div></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/guides/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/api/manual/synopsis">API</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://spectrum.chat/nodegui">Spectrum</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://nodegui.slack.com">Slack</a></li><li class="footer__item"><a class="footer__link-item" to="https://twitter.com/node_gui" href="https://twitter.com/node_gui">Twitter</a></li><li class="footer__item"><a class="footer__link-item" to="https://medium.com/nodegui" href="https://medium.com/nodegui">Medium</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" to="https://react.nodegui.org" href="https://react.nodegui.org">React NodeGui</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/faq">FAQ</a></li></ul></div></div><div class="text--center"><div>Copyright © 2020 NodeGui</div></div></div></footer>
|
|
</div>
|
|
|
|
<script src="/styles.edba8c47.js"></script>
|
|
|
|
<script src="/runtime~main.f5db0c57.js"></script>
|
|
|
|
<script src="/main.2fc10cac.js"></script>
|
|
|
|
<script src="/1.573cf647.js"></script>
|
|
|
|
<script src="/2.a570b951.js"></script>
|
|
|
|
<script src="/1be78505.4cd4b2aa.js"></script>
|
|
|
|
<script src="/20ac7829.f8770b76.js"></script>
|
|
|
|
<script src="/17896441.b3b4e664.js"></script>
|
|
|
|
<script src="/1490091d.6b6226b4.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |