Skip to content

Commit d0888f3

Browse files
committed
update readme
1 parent 8389b2e commit d0888f3

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

License.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2024 chuognmep
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

Readme.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ Jupyter Forge is a powerful library that seamlessly integrates Autodesk Platform
2121
pip install jupyter-forge --upgrade
2222
```
2323

24+
## Requirements
25+
26+
- Python 3.9+
27+
28+
- Setting Environment Variables, see
29+
Tutorial [Create an App](https://aps.autodesk.com/en/docs/oauth/v2/tutorials/create-app/)
30+
31+
Set Environment Variables
32+
33+
```bash
34+
APS_CLIENT_ID=your_client_id
35+
APS_CLIENT_SECRET=your_client_secret
36+
```
37+
2438
## Usage
2539

2640
```python
@@ -36,6 +50,16 @@ object_ids = [123, 456]
3650
forge_viewer.show(object_ids, width=800, height=600)
3751
```
3852

53+
## License
54+
55+
This project is licensed under the Apache License - see the [LICENSE](./License.md) file for details.
56+
57+
## Contributing
58+
59+
This is project just research in my free time and don't have any power to keep it up to date. If you want to contribute,
60+
please feel free to fork and submit a pull request.
61+
62+
3963
## Developers
4064

4165
#### Test Data Readme

0 commit comments

Comments
 (0)