|
8 | 8 | [](./CODE_OF_CONDUCT.md) |
9 | 9 | [](./LICENSE) |
10 | 10 |
|
11 | | -## Table of Contents |
12 | | -<details> |
13 | | -<summary>Installation</summary> |
14 | | - |
15 | | -<ul> |
16 | | -<li><a href="#system-requirements">System requirements</a></li> |
17 | | -<li><a href="#prerequisites">Prerequisites</a></li> |
18 | | -<li><a href="#installing-dependencies">Installing dependencies</a></li> |
19 | | -<li><a href="#building-multitool">Building multitool++</a></li> |
20 | | -<li><a href="#building-a-multitool-release-older-than-v050">Building a multitool++ release older than v0.5.0</a></li> |
21 | | - |
22 | | -</ul> |
23 | | - |
24 | | -</details> |
25 | | - |
26 | | -<details> |
27 | | -<summary>Usage</summary> |
28 | | - |
29 | | -<ul> |
30 | | -<li><a href="#features">Features</a></li> |
31 | | -<li><a href="#faq">FAQ</a></li> |
32 | | -</ul> |
33 | | - |
34 | | -</details> |
35 | | - |
36 | | ---- |
37 | | - |
38 | | -## Installation |
39 | | - |
40 | | -### System requirements |
41 | | - |
42 | | -- If you're using Windows, it must not be older than Windows 10. This is because older Windows systems don't preinstall curl. You may be able to get the software working if you install curl manually on an older Windows system. |
43 | | - |
44 | | -### Prerequisites |
45 | | - |
46 | | -- CMake version over 3.10 |
47 | | -- Linux or Windows system |
48 | | -- Curl installed (check output of curl command in your terminal, most Operating Systems including Windows versions above 10 will have it preinstalled. If you don't have curl, you can try finding a way to install it.) |
49 | | -- If you're using Windows, you need to use the Visual Studio installer to install "Desktop development with C++". |
50 | | -- If you're using Linux, you need to install GCC which will give you G++. |
51 | | - |
52 | | -### Installing dependencies |
53 | | - |
54 | | -#### Windows |
55 | | - |
56 | | -Install [Visual Studio](https://visualstudio.microsoft.com/downloads/) (not the code version). |
57 | | - |
58 | | -In the installer for it, make sure you install "Desktop development with C++". |
59 | | - |
60 | | -Then, run the following command in your terminal: |
61 | | -```cmd |
62 | | -curl --version |
63 | | -``` |
64 | | -If you get an error, run the following command: |
65 | | -```cmd |
66 | | -winget install cURL.cURL |
67 | | -``` |
68 | | -Then, run the following command in your terminal: |
69 | | -```cmd |
70 | | -cmake --version |
71 | | -``` |
72 | | -If you get an error, visit [this page](https://cmake.org/download/) to download CMake. |
73 | | - |
74 | | -You should then install [Git](https://git-scm.com/downloads/win). |
75 | | - |
76 | | -#### Linux |
77 | | - |
78 | | -Using your distro's package manager, install CMake, GCC, Git and curl. |
79 | | - |
80 | | -- **Debian-based** |
81 | | - |
82 | | -```bash |
83 | | -sudo apt install build-essential gcc cmake curl git |
84 | | -``` |
85 | | - |
86 | | -- **Arch-based** |
87 | | - |
88 | | -```bash |
89 | | -sudo pacman -S gcc cmake curl git |
90 | | -``` |
91 | | - |
92 | | -- **Red Hat-based** |
93 | | - |
94 | | -```bash |
95 | | -sudo dnf install gcc gcc-c++ cmake curl git |
96 | | -``` |
97 | | - |
98 | | -- **OpenSUSE** |
99 | | - |
100 | | -```bash |
101 | | -sudo zypper install gcc gcc-c++ cmake curl git |
102 | | -``` |
103 | | - |
104 | | -#### macOS |
105 | | - |
106 | | -macOS support is unplanned. |
107 | | - |
108 | | -### Building multitool++ |
109 | | - |
110 | | -[](https://codeberg.org/multitoolplusplus/app/archive/v1.1.1.tar.gz) |
111 | | -[](https://codeberg.org/multitoolplusplus/app/archive/v1.1.1.zip) |
112 | | - |
113 | | -We generously provide a build.sh and a build.bat to build the software for you. |
114 | | - |
115 | | -After you run the proper build script for your Operating System, the executable will be in the build directory. |
116 | | - |
117 | | -You may also build it manually: |
118 | | - |
119 | | -```sh |
120 | | -mkdir build |
121 | | -cd build |
122 | | -cmake .. |
123 | | -cmake --build . |
124 | | -``` |
125 | | - |
126 | | -### Building a multitool++ release older than v0.5.0 |
127 | | - |
128 | | -Multitool++ releases older than v0.5.0 do not use CMake. For these, you should use G++ or paste the following CMakeLists.txt: |
129 | | - |
130 | | -**For v0.3.0 and newer** |
131 | | - |
132 | | -```cmake |
133 | | -cmake_minimum_required(VERSION 3.10) |
134 | | -
|
135 | | -project(multitool++ VERSION 0.3.0 LANGUAGES CXX) |
136 | | -
|
137 | | -set(CMAKE_CXX_STANDARD 17) |
138 | | -set(CMAKE_CXX_STANDARD_REQUIRED True) |
139 | | -
|
140 | | -# include ./src/*.cpp |
141 | | -file(GLOB_RECURSE SOURCES "src/*.cpp") |
142 | | -
|
143 | | -# add include directories |
144 | | -include_directories("src") |
145 | | -
|
146 | | -# define executable |
147 | | -add_executable(multitool++ ${SOURCES}) |
148 | | -``` |
149 | | - |
150 | | -For v0.2.0 and older, use G++. |
151 | | - |
152 | | -## Usage |
153 | | - |
154 | | -### Features |
155 | | -- [x] Exit |
156 | | -- [x] Timer |
157 | | -- [x] Send message to Discord webhook |
158 | | -- [x] Send message to Telegram bot |
159 | | -- [ ] Send message to Slack bot (see [issue #45](https://codeberg.org/multitoolplusplus/app/issues/45)) |
160 | | -- [x] Generate secure password |
161 | | -- [x] Calculator shell |
162 | | - |
163 | | -### FAQ |
164 | | - |
165 | | -**Q**: Why is the software called "multitool++"? |
166 | | - |
167 | | -**A**: This is because the software is written in C++. |
168 | | - |
169 | 11 | --- |
170 | | -© 2025 multitool++ contributors. Multitool++ is free software licensed under the [GNU GPL v3.0](./LICENSE). |
171 | 12 |
|
| 13 | +We have a wiki where you can find everything you need, like instructions to build the software! Check it out [here](https://multitoolplusplus.codeberg.page/wiki). |
0 commit comments