diff --git a/.gitignore b/.gitignore index 4a587f6..4d781d3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ .idea ENV -ExampleNotebooks/.ipynb_checkpoints \ No newline at end of file +ExampleNotebooks/.ipynb_checkpoints + +# Mac files +.DS_Store \ No newline at end of file diff --git a/README.md b/README.md index 15c01f1..5634b3a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # iPython-Kerner-Changes + + +1. [Introduction](#introduction) +2. [Dev Set Up](#dev-set-up) +3. [Features](#features) + +## 1. Introduction + + ### Docker Instructions (Recommended) 1. `docker build -t dimuthuupe/ipykernel:1.0 .` @@ -29,3 +41,6 @@ ##### Start Tracing Server 1. `sudo python3 tools/tracing-server/strace_server.py` + +#### Known Issues +- [Issue with Mac M1](https://github.com/SciGaP/iPython-Kerner-Changes/issues/8#issue-1383841536)