Skip to content

Commit a504cfc

Browse files
committed
Merge branch 'main' of github.com:lachlangrose/plugin_loopstructural
2 parents bb682a8 + 87b05e2 commit a504cfc

File tree

1 file changed

+0
-87
lines changed

1 file changed

+0
-87
lines changed

README.md

Lines changed: 0 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -7,93 +7,6 @@
77

88

99

10-
## Generated options
11-
12-
### Plugin
13-
14-
| Cookiecutter option | Picked value |
15-
| :-- | :--: |
16-
| Plugin name | LoopStructural |
17-
| Plugin name slugified | loopstructural |
18-
| Plugin name class (used in code) | Loopstructural |
19-
| Plugin category | None |
20-
| Plugin description short | Implict 3D geological modelling in QGIS |
21-
| Plugin description long | This plugin provides an interface to LoopStructural a 3D geological modelling library. |
22-
| Plugin tags | geology,structural geology,3D geology,mining |
23-
| Plugin icon | default_icon.png |
24-
| Plugin with processing provider | False |
25-
| Author name | Lachlan GROSE |
26-
| Author organization | Company |
27-
| Author email | lachlan.grose@monash.edu |
28-
| Minimum QGIS version | 3.28 |
29-
| Maximum QGIS version | 3.99 |
30-
| Git repository URL | https://github.com/Loop3d/loopstructural-qgis/ |
31-
| Git default branch | main |
32-
| License | GPLv2+ |
33-
| Python linter | None |
34-
| CI/CD platform | GitHub |
35-
| IDE | VSCode |
36-
37-
### Tooling
38-
39-
This project is configured with the following tools:
40-
41-
- [Black](https://black.readthedocs.io/en/stable/) to format the code without any existential question
42-
- [iSort](https://pycqa.github.io/isort/) to sort the Python imports
43-
44-
Code rules are enforced with [pre-commit](https://pre-commit.com/) hooks.
45-
46-
See also: [contribution guidelines](CONTRIBUTING.md).
47-
48-
## CI/CD
49-
50-
Plugin is linted, tested, packaged and published with GitHub.
51-
52-
If you mean to deploy it to the [official QGIS plugins repository](https://plugins.qgis.org/), remember to set your OSGeo credentials (`OSGEO_USER_NAME` and `OSGEO_USER_PASSWORD`) as environment variables in your CI/CD tool.
53-
54-
55-
### Documentation
56-
57-
The documentation is generated using Sphinx and is automatically generated through the CI and published on Pages.
58-
59-
- homepage: <https://github.com/Loop3d/loopstructural-qgis/>
60-
- repository: <https://github.com/Loop3d/loopstructural-qgis/>
61-
- tracker: <https://github.com/Loop3d/loopstructural-qgis//issues/>
62-
63-
----
64-
65-
## Next steps
66-
67-
### Set up development environment
68-
69-
> Typical commands on Linux (Ubuntu).
70-
71-
1. If you don't pick the `git init` option, initialize your local repository:
72-
73-
```sh
74-
git init
75-
```
76-
77-
1. Follow the [embedded documentation to set up your development environment](./docs/development/environment.md)
78-
1. Add all files to git index to prepare initial commit:
79-
80-
```sh
81-
git add -A
82-
```
83-
84-
1. Run the git hooks to ensure that everything runs OK and to start developing on quality standards:
85-
86-
```sh
87-
pre-commit run -a
88-
```
89-
90-
### Try to build documentation locally
91-
92-
1. Have a look to the [plugin's metadata.txt file](loopstructural/metadata.txt): review it, complete it or fix it if needed (URLs, etc.).
93-
1. Follow the [embedded documentation to build plugin documentation locally](./docs/development/environment.md)
94-
95-
----
96-
9710
## License
9811

9912
Distributed under the terms of the [`GPLv2+` license](LICENSE).

0 commit comments

Comments
 (0)