Skip to content

Commit 738faf0

Browse files
committed
Updated the README documentation and requirements.txt
Relocated the image directory for documentation
1 parent 1528be9 commit 738faf0

7 files changed

Lines changed: 59 additions & 25 deletions

File tree

README.md

Lines changed: 59 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,69 @@
11
# Conan GUIde
2-
Conan GUIde is Qt based Graphical User Interface (GUI) to interact with conan package manager. Conan GUIde provides user an easy overview of the information from the local cache without any further effort of typing in the terminal. One of the core functionalities from this application is to provide user the possibility to execute the conan development flow from the existing conan recipe.
2+
**Conan GUIde** is Qt based Graphical User Interface (GUI) to interact with local cache of conan package manager. **Conan GUIde** provides user an easy overview of the information from the local cache without any further effort of typing in the terminal. User can find, copy and even open the path of the package with minimal effort and clicks.
33

4-
![](resources/img/main_window.png)
4+
With **Conan GUIde** user has also possibility to add, edit and remove local profiles and remotes of the conan package manager.
55

6-
**⚠ WARNING:** Currently only tested in Windows
6+
One of the core features from this application is the [workspace section](#tab-workspace), that allows user to execute the conan development flow from the existing conan recipe. User can also save the configuration into a file and load it back into workspace. See more in [Tab Workspace](#tab-workspace).
7+
8+
![](https://raw.githubusercontent.com/afri-bit/conan-guide/main/doc/img/tab_cache.png)
9+
10+
**!!! <u>WARNING</u> !!!**
11+
This application is mostly tested in Windows 10 environment. Linux Ubuntu users will have to expect deviated UI representation.
12+
Basic features and functionalitis work well in Linux Ubuntu 18.04 environment.
713

814
## Table of Content
9-
* [Requirements](#Requirements)
10-
* [Features](#Features)
11-
* [Usage](#Usage)
12-
* [Contribution](#Contribution)
13-
* [License](#License)
15+
- [Conan GUIde](#conan-guide)
16+
- [Table of Content](#table-of-content)
17+
- [Requirements](#requirements)
18+
- [Features](#features)
19+
- [Tab Cache](#tab-cache)
20+
- [Tab Workspace](#tab-workspace)
21+
- [Tab Profile](#tab-profile)
22+
- [Tab Remote](#tab-remote)
23+
- [Usage](#usage)
24+
- [Installation using Repository](#installation-using-repository)
25+
- [Installation using PyPI](#installation-using-pypi)
26+
- [Contribution](#contribution)
27+
- [License](#license)
1428

1529
## Requirements
1630
* Python >= 3.5
1731
* Conan >= 1.35 - `pip install conan`
1832
* PySide2 - `pip install PySide2`
19-
* pyperclip - `pip install pyperclip`
2033
* Operating System with activated GUI
2134

2235
## Features
23-
* Execution of conan development flow:
24-
* `create`
25-
* `install`
26-
* `build`
27-
* `source`
28-
* `package`
29-
* `export`
30-
* `export-pkg`
31-
* Display existing conan packages from the local cache
32-
* Display package detail information
33-
* Display list of profiles and its information
34-
* Display list of existing remotes
35-
* Console output
36+
**Conan GUIde** consist multiple tabs, where each tab has a certain area of functionalities.
37+
38+
39+
### Tab Cache
40+
41+
![](https://raw.githubusercontent.com/afri-bit/conan-guide/main/doc/img/tab_cache.png)
42+
43+
**Tab Cache** provides list of recipes and packages, that are installed in the local cache. By selecting one of the recipes or packages, user can see more detailed information, such as description, compiler, architecture, version, `build_type` and further more.
44+
45+
Another important feature for Windows users is information about the data path and the actual package path. This feature saves time for Windows users due to the path separation between the data and the package itself. The package will be stored in the same path as the data path, it only save the reference link, that points to the other directory.
46+
47+
### Tab Workspace
48+
49+
![](https://raw.githubusercontent.com/afri-bit/conan-guide/main/doc/img/tab_workspace.png)
50+
51+
In this section user can configure their workspace and all the needed parameters to build their conan project. **Tab Workspace** also allows users to save their configuration and load it back to this section.
52+
53+
The console widget provides the information during the build process of the conan project.
54+
55+
### Tab Profile
56+
57+
![](https://raw.githubusercontent.com/afri-bit/conan-guide/main/doc/img/tab_profile.png)
58+
59+
The local profiles are listed in this section. User has the capability to add a new empty profile, rename and remove an existing profile. The content of the profile itself can also be edited using the application.
60+
61+
### Tab Remote
62+
63+
![](https://raw.githubusercontent.com/afri-bit/conan-guide/main/doc/img/tab_remote.png)
3664

3765
## Usage
66+
### Installation using Repository
3867
```
3968
git clone https://github.com/afri-bit/conan-guide.git
4069
cd conan-guide
@@ -44,9 +73,15 @@ pip install .
4473
conan-guide
4574
```
4675

76+
### Installation using [PyPI](https://pypi.org/)
77+
78+
```
79+
pip install conan-guide
80+
```
81+
4782
## Contribution
48-
Please refer to [Contributing](CONTRIBUTING.md).
83+
Please refer to [Contributing](https://github.com/afri-bit/conan-guide/blob/main/CONTRIBUTING.md).
4984

5085
## License
51-
**Conan GUIde** is licensed under the [MIT](LICENSE) license.
86+
**Conan GUIde** is licensed under the [MIT](https://github.com/afri-bit/conan-guide/blob/main/LICENSE) license.
5287
Copyright © 2021, Afrizal Herlambang

doc/img/tab_cache.png

63.5 KB
Loading

doc/img/tab_profile.png

25.4 KB
Loading

doc/img/tab_remote.png

29.1 KB
Loading

doc/img/tab_workspace.png

68.8 KB
Loading

requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
conan
2-
pyperclip
32
PySide2

resources/img/main_window.png

-54.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)