You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-16
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ This will install it as package to your Python installation, which will allow yo
61
61
62
62
```bash
63
63
$ python2
64
-
Python 2.7.18 (default, Nov 9 2020, 16:23:15)
64
+
Python 2.7.18 (default, Nov 9 2020, 16:23:15)
65
65
[GCC Apple LLVM 12.0.0 (clang-1200.0.32.21)] on darwin
66
66
Type "help", "copyright", "credits" or "license"for more information.
67
67
>>> from __future__ import print_function
@@ -93,7 +93,7 @@ To include `incendium` as a dependency in PyCharm, you will need to attach it to
93
93
3. Choose `Attach` when prompted
94
94
4. Under the `incendium` project folder, right-click on the `src/` folder and choose `Mark Directory as > Sources Root`
95
95
96
-
#### Installing incendium as a Project on your Gateway
96
+
#### Installing `incendium` as a Project on your Gateway
97
97
98
98
To install incendium on your Gateway follow these steps:
99
99
@@ -107,19 +107,9 @@ To install incendium on your Gateway follow these steps:
107
107
108
108
Alternatively you could follow the instructions for cloning the `project` branch directly into `$IGNITION_DIR/data/projects` found [here](https://github.com/thecesrom/incendium/tree/project#cloning-this-branch).
109
109
110
-
## Contributing to incendium
110
+
## Contributing to `incendium`
111
111
112
-
To contribute to incendium, follow these steps:
113
-
114
-
1. Fork this repository
115
-
2. Create a local copy on your machine
116
-
3. Create a branch
117
-
4. Make sure to run `pre-commit install` to install required pre-commit hooks
118
-
5. Make your changes and commit them
119
-
6. Push to the `code` branch
120
-
7. Create the pull request
121
-
122
-
Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
112
+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
123
113
124
114
## Discussions
125
115
@@ -133,8 +123,8 @@ Up-to-date list of contributors can be found [here](https://github.com/thecesrom
133
123
134
124
## License
135
125
136
-
See the [LICENSE](https://github.com/thecesrom/incendium/blob/HEAD/LICENSE).
126
+
See [LICENSE](./LICENSE).
137
127
138
128
## Code of conduct
139
129
140
-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
0 commit comments