Skip to content

Commit

Permalink
Add description for using stable release instead in documentation...
Browse files Browse the repository at this point in the history
Add description for using stable release instead in documentation (Jfez2qf71P)
  • Loading branch information
Neko-Box-Coder committed Oct 21, 2022
1 parent 3ac6dc0 commit ff7c62c
Show file tree
Hide file tree
Showing 109 changed files with 177 additions and 142 deletions.
25 changes: 18 additions & 7 deletions DocsGeneration/src/🗒️ User Manual/02. Using ssGUI.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,19 @@ Topic: a. Using ssGUI in your CMake project

- *1.* First, you need to git clone recursive ssGUI to the directory you like.
- *a.* Go to the directory you like ssGUI to be in.
- *b.* Run
> git clone https://github.com/Neko-Box-Coder/ssGUI.git --recursive
- *b.* To use latest stable release, Run
> git clone -b v0.93.00.a --recursive --single-branch https://github.com/Neko-Box-Coder/ssGUI.git

- Alternatively, if you want main branch, do
> git clone --recursive https://github.com/Neko-Box-Coder/ssGUI.git


- *2.* Add _ssGUI_ to your _CMakeLists.txt_ with

> add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/directory/to/ssGUI")

- Note that this line *MUST* be after adding SFML packages, so after this line in your _CMakeLists.txt_:
- Note that the above line *MUST* be after adding SFML packages, so after the line below in your _CMakeLists.txt_:

> find_package(SFML 3 COMPONENTS System Window Graphics Network Audio REQUIRED)

Expand Down Expand Up @@ -133,21 +136,29 @@ target_link_libraries(example PUBLIC ssGUI)

Topic: b. Using ssGUI as it is

- *1.* You need to configure CMake, here I am using CMake GUI, it might look slightly different than yours.
- *1.* First, you need to git clone recursive ssGUI to the directory you like.
- *a.* Go to the directory you like ssGUI to be in.
- *b.* To use latest stable release, Run
> git clone -b v0.93.00.a --recursive --single-branch https://github.com/Neko-Box-Coder/ssGUI.git

- Alternatively, if you want main branch, do
> git clone --recursive https://github.com/Neko-Box-Coder/ssGUI.git

- *2.* You need to configure CMake, here I am using CMake GUI, it might look slightly different than yours.

- *2.* Select ssGUI root directory as "source" and a directory for the build, here I created a directory called "Build" at ssGUI root directory.
- *3.* Select ssGUI root directory as "source" and a directory for the build, here I created a directory called "Build" at ssGUI root directory.

(See CMakeGUI.png)

- *3.* Finally, you need to configure it and select the generator for CMake.
- *4.* Finally, you need to configure it and select the generator for CMake.

(See CMakeGUI_2.png)

Here I am just using native default generator.

(See CMakeGUI_3.png)

If your development environment revolve around Visual Studio, you will want to choose Visual Studio as your generator.
If your development environment revolves around Visual Studio, you will want to choose Visual Studio as your generator.

> ⚠️ If you using Visual Studio and using VC16 or below, you will have to specify
> the toolset version number, _v142_ for example for VC16 (Visual Studio 2019)
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<a name="Topic738"></a><div class="CTopic TClass LC first">
<div class="CTitle"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowInterface</div>
<div class="NDClassPrototype HasChildren" id="NDClassPrototype738"><div class="CPEntry TClass Current"><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowInterface</div></div><a class="CPEntry Child TClass" href="../../../../index.html#CClass:ssGUI.Backend.BackendMainWindowSFML" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,679);" onmouseout="NDContentPage.OnLinkMouseOut(event);" ><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowSFML</div></a></div>
<div class="NDClassPrototype HasChildren" id="NDClassPrototype738"><div class="CPEntry TClass Current"><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowInterface</div></div><a class="CPEntry Child TClass" href="../../../../index.html#CClass:ssGUI.Backend.BackendMainWindowSFML" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,1703);" onmouseout="NDContentPage.OnLinkMouseOut(event);" ><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowSFML</div></a></div>
</div>

<a name="Functions"></a><a name="Topic739"></a><div class="CTopic TGroup LC">
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/C/ssGUI/Backend/BackendMainWindowSFML.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@

<script type="text/javascript">var q = window.location.search;if (q.indexOf("?Theme=") == 0){var t = q.slice(7);var e = t.indexOf(";");if (e != -1){ t = t.slice(0, e); }if (document.documentElement.className == undefined){ document.documentElement.className = t + "Theme"; }else{ document.documentElement.className += " " + t + "Theme"; }}</script>

<a name="Topic679"></a><div class="CTopic TClass LC first">
<a name="Topic1703"></a><div class="CTopic TClass LC first">
<div class="CTitle"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowSFML</div>
<div class="NDClassPrototype HasParents" id="NDClassPrototype679"><a class="CPEntry Parent TClass" href="../../../../index.html#CClass:ssGUI.Backend.BackendMainWindowInterface" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,738);" onmouseout="NDContentPage.OnLinkMouseOut(event);" ><div class="CPModifiers"><span class="SHKeyword">public</span></div><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowInterface</div></a><div class="CPEntry TClass Current"><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowSFML</div></div></div>
<div class="NDClassPrototype HasParents" id="NDClassPrototype1703"><a class="CPEntry Parent TClass" href="../../../../index.html#CClass:ssGUI.Backend.BackendMainWindowInterface" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,738);" onmouseout="NDContentPage.OnLinkMouseOut(event);" ><div class="CPModifiers"><span class="SHKeyword">public</span></div><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowInterface</div></a><div class="CPEntry TClass Current"><div class="CPName"><span class="Qualifier">ssGUI::&#8203;Backend::</span>&#8203;BackendMainWindowSFML</div></div></div>
<div class="CBody"><p>For functions explainations, please see <a href="../../../../index.html#CClass:ssGUI.Backend.BackendMainWindowInterface" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,738);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >BackendMainWindowInterface</a>. Normally you don't need to deal with this class</p><div class="CHeading">Variables &amp; Constructor</div><pre class="CCode"><span class="SHKeyword">private</span>:<br /> sf::RenderWindow CurrentWindow; <span class="SHComment">//See &lt;GetRawHandle&gt;</span><br /> std::vector&lt;std::<span class="SHKeyword">function</span>&lt;<span class="SHKeyword">void</span>()&gt;&gt; OnCloseCallback; <span class="SHComment">//See &lt;AddOnCloseEvent&gt;</span><br /> std::vector&lt;std::<span class="SHKeyword">function</span>&lt;<span class="SHKeyword">void</span>(<span class="SHKeyword">bool</span> focused)&gt;&gt; ExternalFocusChangedCallback; <span class="SHComment">//See &lt;AddFocusChangedByUserEvent&gt;</span><br /> <span class="SHKeyword">bool</span> Visible; <span class="SHComment">//See &lt;IsVisible&gt;</span><br /> <span class="SHKeyword">bool</span> VSync; <span class="SHComment">//See &lt;IsVSync&gt;</span><br /> <span class="SHKeyword">bool</span> Closed; <span class="SHComment">//See &lt;IsClosed&gt;</span><br /> ssGUI::Enums::WindowMode CurrentWindowMode; <span class="SHComment">//See &lt;GetWindowMode&gt;</span><br /><br /> <span class="SHKeyword">bool</span> Titlebar; <span class="SHComment">//See &lt;HasTitlebar&gt;</span><br /> <span class="SHKeyword">bool</span> Resizable; <span class="SHComment">//See &lt;IsResizable&gt;</span><br /> <span class="SHKeyword">bool</span> CloseButton; <span class="SHComment">//See &lt;HasCloseButton&gt;</span><br /> std::wstring Title; <span class="SHComment">//See &lt;GetTitle&gt;</span><br /> <span class="SHKeyword">bool</span> IsClosingAborted; <span class="SHComment">//(Internal variable) Flag to stop closing operation, see &lt;AbortClosing&gt;</span><br /><br /> glm::vec2 PositionOffset; <span class="SHComment">//See &lt;GetPositionOffset&gt;</span></pre><pre class="CCode">BackendMainWindowSFML::BackendMainWindowSFML() : CurrentWindow(sf::VideoMode(<span class="SHNumber">800</span>, <span class="SHNumber">600</span>), <span class="SHString">&quot;&quot;</span>),<br /> OnCloseCallback(),<br /> ExternalFocusChangedCallback(),<br /> Visible(<span class="SHKeyword">true</span>),<br /> VSync(<span class="SHKeyword">false</span>),<br /> Closed(<span class="SHKeyword">false</span>),<br /> CurrentWindowMode(ssGUI::Enums::WindowMode::NORMAL),<br /> Titlebar(<span class="SHKeyword">true</span>),<br /> Resizable(<span class="SHKeyword">true</span>),<br /> CloseButton(<span class="SHKeyword">true</span>),<br /> Title(L<span class="SHString">&quot;&quot;</span>),<br /> IsClosingAborted(<span class="SHKeyword">false</span>),<br /> PositionOffset()<br />{<br /> ssGUI::Backend::BackendManager::AddMainWindowInterface(static_cast&lt;ssGUI::Backend::BackendMainWindowInterface*&gt;(<span class="SHKeyword">this</span>));<br />}</pre></div>
</div>

Expand Down
Loading

0 comments on commit ff7c62c

Please sign in to comment.