Skip to content
This repository was archived by the owner on May 26, 2026. It is now read-only.

Commit 384d253

Browse files
authored
readme gitignore and licences
1 parent a625bb6 commit 384d253

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,22 @@ Some IDEs have format on save features and can be configured to use black:
8787
*[insert description]*
8888

8989
## .gitignore
90-
*[insert description]*
90+
The title is pretty self explanatory.
91+
.gitignore is a file where you can add files and directories that you want git to ignore.
92+
The [.gitignore](.gitignore) has the typical content e.g. .venv, the directory that contains the python virtual environment, should not be push to github and is in .gitignore.
9193

9294
## Github Actions
9395
*[insert description]*
9496

9597
## Licences
96-
*[insert description]*
98+
Details about the mainstream OSS (Open source software) licences can be found here:
99+
https://opensource.org
100+
101+
Wikipedia has nice/comprehensive comparison table here:
102+
https://en.wikipedia.org/wiki/Comparison_of_free_and_open-source_software_licences
97103

98104
## TO-DOs:
99105
- [ ] Descriptions for each component
100106
- [X] Add documentation using sphynx
101-
- [ ] Add branch protection rules
102-
- [ ] Add a Makefile for ease of use
107+
- [ ] Add branch protection rules (only in PRO and Enterprise)
108+
- [ ] Add a Makefile for ease of use (make install; make test; make lint; make env?)

0 commit comments

Comments
 (0)